Update an Agent Alias

PUT

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

Updates an existing agent alias.

Purpose:

Enables users to update the alias for an existing agent.

Path Parameters:

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

Request Body:

alias (str): The new alias to update for the agent.

Returns:

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

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

A 400 Bad Request error if the version is invalid.

A 422 Unprocessable Entity error if the alias already exists.

A 500 Internal Server Error for any unexpected failures.

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params

application/json

Required

Examples

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 PUT 'https:///api/v2/agents//alias' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "alias": "string"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "agent_aliases": [
            {
                "id": 0,
                "agent_name": "string",
                "alias": "string",
                "project": {
                    "id": 0,
                    "project_name": "string"
                }
            }
        ]
    }
}

Create an Agent Alias

Delete an Agent Alias