Tenant

Manage tenant settings.

Get all tenant settings.

get

Retrieve all tenant settings.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

excludeMigratedbooleanOptional

When true, excludes settings that have been migrated to external services (e.g., Identity Manager).

Default: false

Responses

200

The complete set of tenant settings.

application/json

activebooleanOptionalExample: true

categorystringOptionalExample: Department

descriptionstringOptionalExample: Enable the department feature

sourcestringOptionalExample: Tenant

labelstringOptionalExample: Show departments

stagestringOptionalExample: Beta

typestringOptionalExample: Boolean

keystringOptionalExample: department.use

valuestringOptionalExample: true

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/v1/k8s/setting

HTTPcURLJavaScriptPython

GET /v1/k8s/setting HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Update a tenant setting.

put

Use to update tenant settings.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

keystringOptionalExample: department.use

valueanyOptionalExample: true

Responses

200

The updated tenant setting.

application/json

msgstringOptionalExample: done

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

put

/v1/k8s/setting

HTTPcURLJavaScriptPython

PUT /v1/k8s/setting HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "key": "department.use",
  "value": true
}

{
  "msg": "done"
}

Get a tenant setting by key.

get

Retrieve a specific tenant setting by key.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

settingKeystringRequired

Responses

200

The requested setting.

application/json

booleanOptional

A boolean value that indicates if the requested setting is enabled.

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/v1/k8s/setting/{settingKey}

HTTPcURLJavaScriptPython

GET /v1/k8s/setting/{settingKey} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true