Delete an Agent

DELETE

/api/v2/agents/{agent_id}

Soft-deletes an agent and marks its associated resources as deleted, without permanently removing them from the database.

Purpose:

Allows users to deactivate an agent while preserving its data for potential recovery, auditing, or historical reference.

Path Parameters:

agent_id (int): ID of the Agent to be soft-deleted.

Request:

No body required. The deletion is performed based on the authenticated user's access and the provided agent ID.

Request Headers:

X-Authorization-Consistency-Token (string, optional): Authorization consistency token for read-after-write consistency. Pass the token received from a previous write operation to ensure this read reflects that write.

Returns:

A JSON response with a success message if the agent is soft-deleted successfully.

A 403 Forbidden error if the user lacks permission to delete the agent.

A 404 Not Found error if the agent does not exist.

A 500 Internal Server Error for unexpected failures.

Current Version:

2.0.0

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Success

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request DELETE 'https:///api/v2/agents/' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {}
}

Update an Agent

Activate an Agent