Get the status of a 'guaranteed' QoS command

GET

/control/{id}

curl --request GET \
  --url https://us-gov.legion.picogrid.com/v2/control/example

• The server that hosts the Legion gov API

Retrieve the current status of a command that was executed with a quality of service of ‘GUARANTEED’. This endpoint allows clients to track the progress of commands that are queued for execution. The command ID is generated upon successful acceptance of the command execution and can be used to retrieve the status.

Parameters

Path Parameters

id

required

string

The ID of the command to retrieve the status for

Query Parameters

terminal_id

string

The identifier of the terminal to retrieve the command status for. This is required if the command was executed on a terminal level

stream_id

string

The identifier of the stream to retrieve the command status for. This is required if the command was executed on a stream level

Responses

200

Command status retrieved successfully for a ‘GUARANTEED’ QoS command

Media typeapplication/json

Represents the response to a command execution request. The structure provides information about the command’s processing status and any relevant results.

object

command_id

A unique identifier for the command request. This can be used for tracking or referencing the command execution. This is only generated for commands with a quality of service of ‘GUARANTEED’.

string format: uuid

message

required

A human-readable message providing additional context about the command status. This can include details about success, failure reasons, or next steps.

string

status

required

The current status of the command execution. Possible values are:

• ACCEPTED: The command was accepted for processing

• REJECTED: The command was not accepted for processing

• SUCCESS: The command was successfully executed

• FAILED: The command failed during execution

string

Allowed values: ACCEPTED REJECTED SUCCESS FAILED

result

Command-specific result data. The structure varies depending on the executed command. This is typically present for SUCCESS or FAILED statuses. Refer to the specific command documentation for details on the expected result structure.

object

key

additional properties

Example

{
  "command_id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "Command execution was accepted.",
  "status": "ACCEPTED",
  "result": {
    "newPosition": {
      "pan": 45,
      "tilt": 30,
      "zoom": 2
    }
  }
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

400

Bad Request Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

401

Authentication Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

403

Unauthorized Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

404

Resource Not Found Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

408

Timeout Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

500

Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link

502

Bad Gateway Error

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Headers

Access-Control-Allow-Origin

string

default: *

Example

https://developer.mozilla.org

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin. - MDN Link

Access-Control-Allow-Credentials

boolean

default: true

The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to the frontend JavaScript code when the request’s credentials mode (Request.credentials) is include. - MDN Link