Get Agent Access

GET

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

Retrieves the access level of a specific agent.

Purpose:

Enables clients to check the access level of an agent for authorization or monitoring purposes.

Staging behaviour:

Pass agent_version=staging as a query parameter to fetch the staging version access level instead of the published agent's.

Path Parameters:

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

Returns:

A JSON response with the serialized agent access data if the agent is found and the filter is valid.

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

Agent Access retrieved successfully

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

Agent Access

Update Agent Access