Sign in

v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB
Agents

Get command queue

Use this endpoint to get details about the command queue of an agent

get/v1/agents/{agentId}/command-queue

Path parameters

agentIdstring uuid required

The ID of the agent

Response

Successful response with command queue details

enabledboolean

Indicates whether the command queue is enabled or not.

namestring

The URL of the command queue. It is returned only for an enabled queue.

visibilityTimeoutinteger

The visibility timeout for messages in the command queue. It is returned only for an enabled queue.

Example response

{
  "enabled": true,
  "name": "https://sqs.us-east-2.amazonaws.com/706717599419/onprem-9b9f275c-a60d-454f-8c6c-1ea094e3fd38.fifo",
  "visibilityTimeout": 600
}