Delete an Agent Alias

DELETE

/api/v2/agents/{agent_id}/alias

Deletes an existing agent alias.

Purpose:

Enables users to delete the alias for an existing agent.

Path Parameters:

agent_id (int): Unique identifier of the agent to delete the alias for.

Returns:

A JSON response with the serialized agent alias data if the alias is deleted successfully.

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

A 400 Bad Request error if the version is invalid.

A 500 Internal Server Error for any unexpected failures.

Current Version:

2.0.0

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request DELETE 'https:///api/v2/agents//alias' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "agent_aliases": [
            {
                "id": 0,
                "agent_name": "string",
                "alias": "string",
                "project": {
                    "id": 0,
                    "created_by": "string",
                    "created_on": "2019-08-24T14:15:22Z",
                    "modified_by": "string",
                    "modified_on": "2019-08-24T14:15:22Z",
                    "project_name": "string",
                    "team_visibility": true,
                    "is_deleted": true,
                    "team": 0
                }
            }
        ]
    }
}

Update an Agent Alias

Get all Agent Aliases