🧩 Multi-tenants
Get the list of all tenants.
Get the list of tenants. The special '*' and '-' are not included in the returned values.
get/tenants
Request
- Base URLhttps://rudder.example.com/rudder/api/latest
- AuthAPI key in header X-API-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
The list of tenants with their documentation information
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.