v2

latestOpenAPI 3.1.0CC-BY-SA 2.02026-07-2617789528.6 KB
🧩 Multi-tenants

Get tenant details

Get detailed information about one tenant

get/tenants/{id}

Path parameters

idstring string matching ^(\p{Alnum}[\p{Alnum}-_]*)$ required
Example:zone-1

Id of the tenant

Response

Tenant information

result'success' | 'error' required

Result of the request

action'getTenant' required

The id of the action

Example response

{
  "data": {
    "tenants": [
      {
        "id": "zone-1",
        "name": "Zone 1",
        "description": "zone-1 tenants holds nodes for the European geo zone",
        "documentation": "zone-1 tenants holds nodes for the European geo zone. The region is split as: ... etc ..."
      }
    ]
  }
}