Get tenant details

Get detailed information about one tenant

get/tenants/{id}

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/tenants/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

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 ..."
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 7 revisions of this API.