Sign in

v2

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

Add one or more tenants

Add one or more tenants to existing list. Already defined tenants (same id) are updated

post/tenants

Request body

idstring

A unique identifier for a tenant, matching ^(\p{Alnum}[\p{Alnum}-_]*)$

namestring

A name for humans

descriptionstring

One line description of the tenant, typically used to get a glimpse of tenant goal.

documentationstring

A long form description of the tenant, accepting markdown

Example request

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

Response

List of actually added/updated tenants

result'success' | 'error' required

Result of the request

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