GET
/
api
/
v1
/
platform
/
tenants
List tenants
curl --request GET \
  --url https://api.example.com/api/v1/platform/tenants \
  --header 'X-Api-Id: <x-api-id>' \
  --header 'X-Api-Nonce: <x-api-nonce>' \
  --header 'X-Api-Signature: <api-key>' \
  --header 'X-Api-Timestamp: <x-api-timestamp>'
[
  {
    "tenant_id": "tenant_001",
    "name": "Tenant 001",
    "status": "ACTIVE",
    "request_id": "req-001"
  }
]

Authorizations

​
X-Api-Signature
string
header
required

UTMOS HMAC request signature with X-Api-Id, X-Api-Timestamp and X-Api-Nonce.

Headers

​
X-Api-Id
string
required

Platform or tenant administrator credential

​
X-Api-Timestamp
string
required

Unix seconds

​
X-Api-Nonce
string
required

Replay-protection nonce

​
X-Api-Signature
string
required

HMAC signature

​
X-Request-Id
string

Caller correlation ID; generated when omitted

Query Parameters

​
limit
integer
default:100

Maximum number of records returned by a list endpoint. Defaults to 100; max 500.

Required range: 1 <= x <= 500

Response

OK

​
tenant_id
string
required
​
name
string
required
​
status
enum<string>
required
Available options:
ACTIVE,
DISABLED,
DELETED
​
request_id
string
required