Beetl Docs
MCP and programmatic accessREST API

Tenants

List_tenants

GET/api/tenants

Authorization

api_key
X-API-Key<token>

In: header

Query Parameters

status?null|

Response Body

application/json

curl -X GET "https://example.com/api/tenants"
{  "tenants": [    {      "created_at": "2019-08-24T14:15:22Z",      "default_object_store_id": "de9e8514-d6c0-46eb-9a55-a78c05224752",      "name": "string",      "sites": null,      "slug": "string",      "status": "Active",      "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",      "updated_at": "2019-08-24T14:15:22Z",      "zitadel_org_id": "string"    }  ]}

Create_tenant

POST/api/tenants

Authorization

api_key
X-API-Key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/tenants" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "sites": [      {        "name": "string"      }    ]  }'
{  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0"}

Get_tenant

GET/api/tenants/{tenant_id}

Authorization

api_key
X-API-Key<token>

In: header

Path Parameters

tenant_id*string

Tenant ID

Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/api/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "created_at": "2019-08-24T14:15:22Z",  "default_object_store_id": "de9e8514-d6c0-46eb-9a55-a78c05224752",  "name": "string",  "sites": null,  "slug": "string",  "status": "Active",  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",  "updated_at": "2019-08-24T14:15:22Z",  "zitadel_org_id": "string"}

List_object_stores

GET/api/tenants/{tenant_id}/object-stores

Authorization

api_key
X-API-Key<token>

In: header

Path Parameters

tenant_id*string

Tenant ID

Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/api/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/object-stores"
{  "object_stores": [    {      "configuration": {        "base_url": "string",        "option_keys": [          "string"        ]      },      "created_at": "2019-08-24T14:15:22Z",      "is_default": true,      "name": "string",      "object_store_id": "0981659b-0adc-49c3-902c-26e9d16152f2",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

Register_object_store

POST/api/tenants/{tenant_id}/register-object-store

Authorization

api_key
X-API-Key<token>

In: header

Path Parameters

tenant_id*string

Tenant ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/register-object-store" \  -H "Content-Type: application/json" \  -d '{    "base_url": "string",    "name": "string",    "options": {      "property1": "string",      "property2": "string"    }  }'
{  "object_store_id": "0981659b-0adc-49c3-902c-26e9d16152f2"}

Select_default_object_store

POST/api/tenants/{tenant_id}/select-default-object-store

Authorization

api_key
X-API-Key<token>

In: header

Path Parameters

tenant_id*string

Tenant ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/select-default-object-store" \  -H "Content-Type: application/json" \  -d '{    "object_store_id": "0981659b-0adc-49c3-902c-26e9d16152f2"  }'
Empty

Retry_superset_connection

POST/api/tenants/{tenant_id}/superset-connection/retry

Authorization

api_key
X-API-Key<token>

In: header

Path Parameters

tenant_id*string

Tenant ID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/superset-connection/retry"
{  "status": "Pending"}

Rotate_superset_credential

POST/api/tenants/{tenant_id}/superset-connection/rotate

Authorization

api_key
X-API-Key<token>

In: header

Path Parameters

tenant_id*string

Tenant ID

Formatuuid

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/superset-connection/rotate"
Empty

Suspend_tenant

POST/api/tenants/{tenant_id}/suspend

Authorization

api_key
X-API-Key<token>

In: header

Path Parameters

tenant_id*string

Tenant ID

Formatuuid

Response Body

application/json

application/json

curl -X POST "https://example.com/api/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/suspend"
Empty

Update_object_store_options

POST/api/tenants/{tenant_id}/update-object-store-options

Authorization

api_key
X-API-Key<token>

In: header

Path Parameters

tenant_id*string

Tenant ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/update-object-store-options" \  -H "Content-Type: application/json" \  -d '{    "object_store_id": "0981659b-0adc-49c3-902c-26e9d16152f2",    "options": {      "property1": "string",      "property2": "string"    }  }'
Empty

Status and health

Previous Page

Users

Next Page