Get instance configuration

GET

/api/v1/admin/config

const url = 'https://example.com/api/v1/admin/config';
const options = {method: 'GET', headers: {Authorization: 'Bearer <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/admin/config \
  --header 'Authorization: Bearer <token>'

Returns the instance configuration. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/admin/config. Inputs: . Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Responses

200

application/json

GET config gives the UI a readable schedule and the same IANA zone the scheduler uses. The on-disk InstanceConfig keeps the cron string private.

object

apple_app_ids

required

Array<string>

backup_retention

required

integer

backup_schedule

required

string

dedup_scrub_schedule

required

object

day

One of:

string
null

string

Allowed values: monday tuesday wednesday thursday friday saturday sunday

frequency

One of:

string
null

None means an older custom cron schedule that the simple control cannot represent yet. The UI asks the admin to choose a new value.

string

Allowed values: weekly daily off

time

string | null

timezone

required

string

default_quota

required

integer format: int64

instance_name

required

string

oidc_providers

required

Array<object>

object

admin_group

required

string

client_id

required

string

client_secret

required

string

groups_authoritative

boolean

groups_claim

required

string

guest_group

required

string

issuer

required

string

name

required

string

open_signup

required

boolean

profile_signing

required

object

display_name

The company name from the Developer ID common name, with its team ID removed.

string | null

enabled

required

True when the certificate and chain are currently valid.

boolean

expires_at

The earliest expiry time in the signer certificate chain, in Unix seconds.

integer | null format: int64

expires_soon

required

True when the earliest expiry is within 30 days.

boolean

user_deletion_archive_days

required

integer format: int32

version

required

integer format: int32

video_cache_max_bytes

required

integer format: int64

Example

{
  "dedup_scrub_schedule": {
    "day": "monday",
    "frequency": "weekly"
  }
}