Queue
Get Queue
Endpoint to retrieve a single Queue by ID
post/message-queue/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Queue to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true,
"messagingSystem": true,
"brokerScope": true,
"discoverySource": true
}
}Response
Successful response
Example response
{
"data": {
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"name": "orders.created",
"slug": "example-slug-value",
"description": "Order events from checkout to fulfilment",
"queueIdentifier": "kafka||orders.created",
"messagingSystem": "kafka",
"destinationName": "orders.created",
"brokerScope": "orders-prod",
"brokerAddress": "kafka-1.internal:9092",
"discoverySource": "traces",
"lastSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"brokerMetricsLastSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"autoArchivedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"manuallyRestoredAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"automaticAssignments": {
"key": "value",
"nested": {
"data": 123
}
},
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"isArchived": true,
"archivedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"labels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.