Skip to content
calternal docs

Update instance configuration

PUT
/api/v1/admin/config
curl --request PUT \
  --url https://example.com/api/v1/admin/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "apple_app_ids": [ "example" ], "backup_retention": 1, "backup_schedule": "example", "dedup_scrub_schedule": "example", "default_quota": 1, "instance_name": "example", "oidc_providers": [ { "admin_group": "example", "client_id": "example", "client_secret": "example", "groups_authoritative": true, "groups_claim": "example", "guest_group": "example", "issuer": "example", "name": "example" } ], "open_signup": true, "profile_signing": { "certificate_pem_file": "example", "chain_pem_file": "example", "private_key_file": "example" }, "user_deletion_archive_days": 1, "version": 1, "video_cache_max_bytes": 1 }'

Updates 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: . A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
apple_app_ids
Array<string>
backup_retention
required
integer
backup_schedule
required
string
dedup_scrub_schedule

Six-field wall-clock cron expression for the low-priority file check. The server evaluates it in the Instance time zone. An empty string means the scheduled check is off.

string
default_quota
integer format: int64
instance_name
required
string
oidc_providers
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
One of:

Optional files below .system/secrets/ used to sign Apple profiles.

object
certificate_pem_file
required
string
chain_pem_file
required
string
private_key_file
required
string
user_deletion_archive_days
integer format: int32
version
required
integer format: int32
video_cache_max_bytes

Maximum bytes used by completed cached video renditions.

integer format: int64
Examplegenerated
{
  "apple_app_ids": [
    "example"
  ],
  "backup_retention": 1,
  "backup_schedule": "example",
  "dedup_scrub_schedule": "example",
  "default_quota": 1,
  "instance_name": "example",
  "oidc_providers": [
    {
      "admin_group": "example",
      "client_id": "example",
      "client_secret": "example",
      "groups_authoritative": true,
      "groups_claim": "example",
      "guest_group": "example",
      "issuer": "example",
      "name": "example"
    }
  ],
  "open_signup": true,
  "profile_signing": {
    "certificate_pem_file": "example",
    "chain_pem_file": "example",
    "private_key_file": "example"
  },
  "user_deletion_archive_days": 1,
  "version": 1,
  "video_cache_max_bytes": 1
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
apple_app_ids
Array<string>
backup_retention
required
integer
backup_schedule
required
string
dedup_scrub_schedule

Six-field wall-clock cron expression for the low-priority file check. The server evaluates it in the Instance time zone. An empty string means the scheduled check is off.

string
default_quota
integer format: int64
instance_name
required
string
oidc_providers
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
One of:

Optional files below .system/secrets/ used to sign Apple profiles.

object
certificate_pem_file
required
string
chain_pem_file
required
string
private_key_file
required
string
user_deletion_archive_days
integer format: int32
version
required
integer format: int32
video_cache_max_bytes

Maximum bytes used by completed cached video renditions.

integer format: int64
Examplegenerated
{
  "apple_app_ids": [
    "example"
  ],
  "backup_retention": 1,
  "backup_schedule": "example",
  "dedup_scrub_schedule": "example",
  "default_quota": 1,
  "instance_name": "example",
  "oidc_providers": [
    {
      "admin_group": "example",
      "client_id": "example",
      "client_secret": "example",
      "groups_authoritative": true,
      "groups_claim": "example",
      "guest_group": "example",
      "issuer": "example",
      "name": "example"
    }
  ],
  "open_signup": true,
  "profile_signing": {
    "certificate_pem_file": "example",
    "chain_pem_file": "example",
    "private_key_file": "example"
  },
  "user_deletion_archive_days": 1,
  "version": 1,
  "video_cache_max_bytes": 1
}