THthingsboard
queue-controller

Get Queue (getQueueByName)

Fetch the Queue object based on the provided Queue name.

Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.

get/api/queues/name/{queueName}

Request

Path parameters

queueNamestring required

A string value representing the queue id. For example, 'Main'

Response

OK

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

namestring
topicstring
pollIntervalinteger
partitionsinteger
consumerPerPartitionboolean
packProcessingTimeoutinteger
additionalInfounknown

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "QUEUE"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "additionalInfo": {}
}

Changes

No recorded changes to this operation across all 2 revisions of this API.