Get all MQTT topics

GET

/v3/tasking/entity/{entityId}/mqtt-topics/all

curl --request GET \
  --url https://us-gov.legion.picogrid.com/v3/tasking/entity/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/mqtt-topics/all

• US Government Production API
• Staging API
• Demo API

Fetches all MQTT topics registered for the specified entity ID.

Parameters

Path Parameters

entityId

required

string format: uuid

Query Parameters

offset

number

limit

number

Responses

200

Successful response

Media typeapplication/json

object

paging

required

object

next

number

previous

number

results

required

Array<object>

object

command_name

required

string

created_at

required

string

/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$/

entity_id

required

string format: uuid

id

required

string format: uuid

request_mqtt_topic

required

string

response_mqtt_topic

required

string

updated_at

required

string

/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$/

total_count

required

number

Example

{
  "paging": "sample_value",
  "results": [
    {
      "command_name": "restart",
      "created_at": "2023-01-01T10:00:00Z",
      "entity_id": "b7c5e4d3-a2b1-4f0e-8d9c-1a2b3c4d5e6f",
      "request_mqtt_topic": "HS1040/task/request/aws/restart",
      "response_mqtt_topic": "HS1040/task/response/aws/restart",
      "updated_at": "2023-01-15T15:30:45Z"
    }
  ],
  "total_count": "5"
}

400

Bad Request

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "400",
  "details": "sample_value",
  "message": "Request cannot be processed due to invalid input",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

401

Unauthorized

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "401",
  "details": "sample_value",
  "message": "Authentication credentials are missing or invalid",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

403

Forbidden

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "403",
  "details": "sample_value",
  "message": "Access denied: insufficient permissions for this resource",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

404

Not Found

Media typeapplication/json

object

category

string

code

number

details

Array<object>

object

field

required

string

issue

required

string

message

string

status

string

timestamp

string

trace_id

string

Example

{
  "code": "404",
  "details": "sample_value",
  "message": "The requested resource could not be found",
  "status": "error",
  "timestamp": "2025-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

500

Internal Server Error

Media typeapplication/json

object

category

required

The category of the error

string

code

required

The HTTP status code

number

details

required

Additional details about the error

Array<object>

object

field

The field that caused the error

string

issue

The specific issue with the field

string

message

required

A human-readable error message

string

status

required

The status of the response, always ‘error’ for error responses

string

timestamp

required

The timestamp when the error occurred

string format: date-time

trace_id

required

A unique identifier for tracing the error

string format: uuid

Example

{
  "category": "server_error",
  "code": "500",
  "details": [
    {
      "field": "field_name",
      "issue": "Field validation issue"
    }
  ],
  "message": "Internal Server Error",
  "status": "error",
  "timestamp": "2024-03-15T10:30:00Z",
  "trace_id": "b7c5e4d3-a2b1-4f0e-8d9c-1a2b3c4d5e6f"
}