Get settings

GET

/api/v1/instance/settings

const url = 'https://example.com/api/v1/instance/settings';
const options = {method: 'GET', headers: {cookie: 'ttx_access_token=<ttx_access_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/instance/settings \
  --cookie ttx_access_token=<ttx_access_token>

The instance’s tenancy rule and its settings.

Authorizations

sessionCookie

Responses

200

Successful Response

application/json

InstanceSettingsRead

object

max_organizations

required

Any of:

integer
null

integer

organization_count

required

Organization Count

integer

pinned_by_env

required

Pinned By Env

boolean

tenancy_mode

required

Tenancy Mode

string

Allowed values: open single managed

Example

{
  "tenancy_mode": "open"
}