Update Agent Access

PUT

/api/v2/agents/{agent_id}/access

Updates the access level of a specific agent.

Purpose:

Allows users to modify the access level of an agent for security or organizational purposes.

Staging behaviour:

modifies the access level of the agent in staging version instead of published agent.

Changes are propagated to the published agent via the Publish API(POST api/v2/agents/{agent_id}/publish).

Path Parameters:

agent_id (int): Unique identifier of the agent whose access level is being updated.

Request Body:

A JSON object containing the updated access level for the agent.

Returns:

A JSON response with the serialized updated agent access data if the update is successful.

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

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

A 400 Bad Request or 500 Internal Server Error if the update fails due to validation or server issues.

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params

application/json

Required

Examples

Responses

🟢200OK

application/json

Agent Access updated successfully

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "agent_name": "string",
        "access": "string"
    }
}

Get Agent Access

Agent Alias