Administration

Fetch list of tenants

Fetch a list of tenants in the system.

Note: Requires administrator permissions.

get/_api/tenants

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/tenants/get.ts
A function with typed inputs. Its response is checked against the schema.

Successfully fetched tenants.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

{
  "code": 200,
  "result": {
    "tenant": "__system",
    "dcList": [
      "sol1-ap-west"
    ],
    "status": "available"
  }
}

No recorded changes to this operation across all 1 revision of this API.