> For the complete documentation index, see [llms.txt](https://guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guardian.hedera.com/docs/develop/guardian/tokens/retirement-contract/retirement-apis.md). # Retirement APIs Endpoints for creating and managing Guardian retirement contracts, retire pools, wipe requests, and associated administrators. **Authentication:** Bearer token required (`Authorization: Bearer `) *** | Method | Endpoint | Description | Auth Required | | -------- | -------------------------------------------------------- | --------------------------------------- | ------------- | | `GET` | `/api/v1/contracts` | Returns all retirement contracts | Yes | | `POST` | `/api/v1/contracts` | Creates a new retirement contract | Yes | | `POST` | `/api/v1/contracts/import` | Imports an existing retirement contract | Yes | | `DELETE` | `/api/v1/contracts/{contractId}` | Removes a retirement contract | Yes | | `GET` | `/api/v1/contracts/{contractId}/permissions` | Returns permissions for the contract | Yes | | `POST` | `/api/v1/contracts/retire/{contractId}/admin/{hederaId}` | Adds a retire administrator | Yes | | `DELETE` | `/api/v1/contracts/retire/{contractId}/admin/{hederaId}` | Removes a retire administrator | Yes | | `GET` | `/api/v1/contracts/retire/pools` | Returns all retire pools | Yes | | `POST` | `/api/v1/contracts/retire/pools` | Sets retire pools | Yes | | `DELETE` | `/api/v1/contracts/retire/pools` | Deletes retire pools | Yes | | `DELETE` | `/api/v1/contracts/retire/pools/{poolId}` | Unsets a retire pool | Yes | | `POST` | `/api/v1/contracts/retire/pools/sync` | Synchronizes retire pools | Yes | | `GET` | `/api/v1/contracts/retire/requests` | Returns all retire requests | Yes | | `DELETE` | `/api/v1/contracts/retire/requests` | Deletes all retire requests | Yes | | `POST` | `/api/v1/contracts/retire/requests/{requestId}/approve` | Approves a retire request | Yes | | `DELETE` | `/api/v1/contracts/retire/requests/{requestId}` | Cancels a retire request | Yes | | `POST` | `/api/v1/contracts/retire` | Retires tokens | Yes | | `GET` | `/api/v1/contracts/retire` | Returns all retired VCs | Yes | | `GET` | `/api/v1/contracts/wipe/requests` | Returns all wipe requests | Yes | | `POST` | `/api/v1/contracts/wipe/requests/{requestId}/approve` | Approves wipe requests | Yes | | `DELETE` | `/api/v1/contracts/wipe/requests` | Clears wipe requests | Yes | | `DELETE` | `/api/v1/contracts/wipe/requests/{requestId}` | Rejects wipe requests | Yes | | `POST` | `/api/v1/contracts/{contractId}/wipe/admin/{hederaId}` | Adds a wipe administrator | Yes | | `DELETE` | `/api/v1/contracts/{contractId}/wipe/admin/{hederaId}` | Removes a wipe administrator | Yes | | `POST` | `/api/v1/contracts/{contractId}/wipe/manager/{hederaId}` | Adds a wipe manager | Yes | | `DELETE` | `/api/v1/contracts/{contractId}/wipe/manager/{hederaId}` | Removes a wipe manager | Yes | | `POST` | `/api/v1/contracts/{contractId}/wipe/wiper/{hederaId}` | Adds a wipe wiper | Yes | | `DELETE` | `/api/v1/contracts/{contractId}/wipe/wiper/{hederaId}` | Removes a wipe wiper | Yes | | `POST` | `/api/v1/contracts/{contractId}/wipe/requests/enable` | Enables wipe requests | Yes | | `POST` | `/api/v1/contracts/{contractId}/wipe/requests/disable` | Disables wipe requests | Yes | ## Endpoints * [Returns All Contracts](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/returns-all-contracts.md) * [Creating New Contract](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/creating-new-contract.md) * [Importing New Contract](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/importing-new-contract.md) * [Removing Contract](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/removing-contract.md) * [Get Contract Permissions](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/get-contract-permissions.md) * [Adding Retire Admin](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/adding-retire-admin.md) * [Removing Retire Admin](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/removing-retire-admin.md) * [Returning List of All Retire Pools](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/returning-list-of-all-retire-pools.md) * [Setting Retire Pools](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/setting-retire-pools.md) * [Deleting Retire Pools](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/deleting-retire-pools.md) * [Unsetting Retire Pool](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/unsetting-retire-pool.md) * [Syncing Retire Pools](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/syncing-retire-pools.md) * [Returning List of All Retire Requests](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/returning-list-of-all-retire-requests.md) * [Deleting Retire Requests](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/deleting-retire-requests.md) * [Approving Retire Request](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/approving-retire-request.md) * [Cancelling Retire Request](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/cancelling-retire-request.md) * [Retiring Tokens](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/retiring-tokens.md) * [Returning All Retired VCs](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/returning-all-retired-vcs.md) * [Returns a List of All Wipe Requests](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/returns-a-list-of-all-wipe-requests.md) * [Approving Wipe Requests](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/approving-wipe-requests.md) * [Clearing Wipe Requests](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/clearing-wipe-requests.md) * [Rejecting Wipe Requests](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/rejecting-wipe-requests.md) * [Adding Wipe Admin](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/adding-wipe-admin.md) * [Removing Wipe Admin](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/removing-wipe-admin.md) * [Adding Wipe Manager](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/adding-wipe-manager.md) * [Removing Wipe Manager](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/removing-wipe-manager.md) * [Adding Wipe Wiper](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/adding-wipe-wiper.md) * [Removing Wipe Wiper](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/removing-wipe-wiper.md) * [Enabling Wipe Requests](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/enabling-wipe-requests.md) * [Disabling Wipe Requests](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/disabling-wipe-requests.md) * [Adding Wipe for Specific Token](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/adding-wipe-for-specific-token.md) * [Deleting Wipe Request for Hedera Account](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/deleting-wipe-request-for-hedera-account.md) * [Get Retirement VCs from Indexer](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/get-retirement-vcs-from-indexer.md) * [Remove Wipe Request for Specific Token](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/remove-wipe-request-for-specific-token.md) * [Unsetting Retire Request](/docs/develop/guardian/tokens/retirement-contract/retirement-apis/unsetting-retire-request.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://guardian.hedera.com/docs/develop/guardian/tokens/retirement-contract/retirement-apis.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.