Unregister an on-premises agent
Use this endpoint to unregister an on-premises agent and remove the platform resources associated with it.
Endpoint
DELETE /api/v1/agents/{id}
Path parameters
| Parameter | Description |
|---|---|
id | The unique identifier of the agent. |
Resources removed
Unregistering an agent removes the agent and the following associated platform resources:
- Identity Provider (IDP) account
- Identity Management (IDM) roles
- Data Service (DS) data agent and data source
- Message Gateway (MSGGW) consumer
- RabbitMQ account
If no other agent is associated with the connector, the connector is removed as well.
Response codes
| Status code | Description |
|---|---|
201 | The agent was unregistered successfully. |
404 | The agent was not found. |
422 | One or more associated resources could not be removed. |
500 | An internal server error occurred. |
If the endpoint returns 422, you can safely retry the operation.