Describe a queue
curl --request GET \
--url https://queue.{region}.basaltic.sh/v1/queues/{queue_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://queue.{region}.basaltic.sh/v1/queues/{queue_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://queue.{region}.basaltic.sh/v1/queues/{queue_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://queue.{region}.basaltic.sh/v1/queues/{queue_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://queue.{region}.basaltic.sh/v1/queues/{queue_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://queue.{region}.basaltic.sh/v1/queues/{queue_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://queue.{region}.basaltic.sh/v1/queues/{queue_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"queue": {
"id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"crn": "crn:queue:sa-saopaulo-1:my-account:queue/orders",
"name": "orders",
"kind": "standard",
"attributes": {
"visibility_timeout_seconds": 30,
"message_retention_seconds": 345600,
"max_message_bytes": 262144,
"delay_seconds": 0,
"receive_wait_time_seconds": 0,
"kms_data_key_reuse_period_seconds": 300
},
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-18T11:45:00Z",
"redrive_policy": {
"dead_letter_queue": {
"id": "b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"crn": "crn:queue:sa-saopaulo-1:acme:queue/failed-orders",
"name": "failed-orders"
},
"max_receive_count": 5
},
"content_based_deduplication": false,
"kms_key": {
"id": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
"crn": "crn:kms:sa-saopaulo-1:acme:key/service-key",
"name": "service-key"
},
"tags": {
"environment": "production",
"team": "backend"
},
"depth": {
"approximate_available": 42,
"approximate_in_flight": 3,
"approximate_delayed": 0,
"counts_capped": false
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Queues
Describe a queue
GET
/
v1
/
queues
/
{queue_id}
Describe a queue
curl --request GET \
--url https://queue.{region}.basaltic.sh/v1/queues/{queue_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://queue.{region}.basaltic.sh/v1/queues/{queue_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://queue.{region}.basaltic.sh/v1/queues/{queue_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://queue.{region}.basaltic.sh/v1/queues/{queue_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://queue.{region}.basaltic.sh/v1/queues/{queue_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://queue.{region}.basaltic.sh/v1/queues/{queue_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://queue.{region}.basaltic.sh/v1/queues/{queue_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"queue": {
"id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"crn": "crn:queue:sa-saopaulo-1:my-account:queue/orders",
"name": "orders",
"kind": "standard",
"attributes": {
"visibility_timeout_seconds": 30,
"message_retention_seconds": 345600,
"max_message_bytes": 262144,
"delay_seconds": 0,
"receive_wait_time_seconds": 0,
"kms_data_key_reuse_period_seconds": 300
},
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-18T11:45:00Z",
"redrive_policy": {
"dead_letter_queue": {
"id": "b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
"crn": "crn:queue:sa-saopaulo-1:acme:queue/failed-orders",
"name": "failed-orders"
},
"max_receive_count": 5
},
"content_based_deduplication": false,
"kms_key": {
"id": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
"crn": "crn:kms:sa-saopaulo-1:acme:key/service-key",
"name": "service-key"
},
"tags": {
"environment": "production",
"team": "backend"
},
"depth": {
"approximate_available": 42,
"approximate_in_flight": 3,
"approximate_delayed": 0,
"counts_capped": false
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Requires the IAM action
queue:DescribeQueue. See QUEUE permissions for the full list, what each one covers, and an example policy.Authorizations
An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>.
This is the recommended way to authenticate.
Get one by exchanging a service account's access key pair at
POST /v1/oauth/token with grant_type=client_credentials. It is the
standard client-credentials grant, so any OAuth-aware library will
obtain and refresh it for you.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.
Path Parameters
Example:
"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
Response
Queue attributes and its approximate message counts.
Show child attributes
Show child attributes

