System Settings

Settings related to the system.

Update the system settings

SecurityaccessToken
Request
query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
object
object

Top level system resource defaults used for all hosts in all sites. These default values may be overridden by system resource profiles configured on specific sites or specific hosts.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

patch/v1/config/system/settings
Request samples
sites:
  disconnected-grace-period: 90d
  application-owner-location-resolution: 2
  location-publish-interval: 5m
  location-persist-interval: 1h
resource-defaults:
  memory:
    memory-limit: 8GiB
  cpus:
    cpus-limit: 4.0
  container-storage:
    container-layer-storage-limit: 500MiB
  device-labels:
    - label: video-dev
      udev-patterns:
        - SUBSYSTEM=="video4linux", BUS=="usb"
  gpu-labels:
    - label: gpu-all
      max-number-gpus: 1
      all: true
  system-volumes:
    - name: daemon-socket
      path: /var/run/my-daemon.sock
      mode: read-only

Delete the system settings

SecurityaccessToken
Request
query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

delete/v1/config/system/settings

Replace or create the system settings

SecurityaccessToken
Request
query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
object
object

Top level system resource defaults used for all hosts in all sites. These default values may be overridden by system resource profiles configured on specific sites or specific hosts.

Responses
201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

put/v1/config/system/settings
Request samples
sites:
  disconnected-grace-period: 90d
  application-owner-location-resolution: 2
  location-publish-interval: 5m
  location-persist-interval: 1h
resource-defaults:
  memory:
    memory-limit: 8GiB
  cpus:
    cpus-limit: 4.0
  container-storage:
    container-layer-storage-limit: 500MiB
  device-labels:
    - label: video-dev
      udev-patterns:
        - SUBSYSTEM=="video4linux", BUS=="usb"
  gpu-labels:
    - label: gpu-all
      max-number-gpus: 1
      all: true
  system-volumes:
    - name: daemon-socket
      path: /var/run/my-daemon.sock
      mode: read-only

Retrieve the configuration of system settings

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
200

OK

304

Not Modified

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/system/settings
Response samples
sites:
  disconnected-grace-period: 90d
  application-owner-location-resolution: 2
  location-publish-interval: 5m
  location-persist-interval: 1h
resource-defaults:
  memory:
    memory-limit: 8GiB
  cpus:
    cpus-limit: 4.0
  container-storage:
    container-layer-storage-limit: 500MiB
  device-labels:
    - label: video-dev
      udev-patterns:
        - SUBSYSTEM=="video4linux", BUS=="usb"
  gpu-labels:
    - label: gpu-all
      max-number-gpus: 1
      all: true
  system-volumes:
    - name: daemon-socket
      path: /var/run/my-daemon.sock
      mode: read-only

Retrieve the certificate ttls

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/certificate-ttls
Response samples
api-certificates:
  root-ca:
    ttl: 3y120d
    renew-threshold: 1y175d
    activate-threshold: 1y40d
  site-ca:
    ttl: 1y40d
    renew-threshold: 135d
    activate-threshold: 0s
  endpoint-certificate:
    ttl: 135d
    renew-threshold: 90d
site-cluster-certificates:
  root-ca:
    ttl: 2y350d
    renew-threshold: 270d
    activate-threshold: 135d
  host-certificate:
    ttl: 135d
    renew-threshold: 90d

Retrieve the the state of system settings

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/system/settings
Response samples
sites:
  disconnected-grace-period: 90d
  application-owner-location-resolution: 2
  location-publish-interval: 5m
  location-persist-interval: 1h
resource-defaults:
  memory:
    memory-limit: 8GiB
  cpus:
    cpus-limit: 4.0
  container-storage:
    container-layer-storage-limit: 500MiB
  device-labels:
    - label: video-dev
      udev-patterns:
        - SUBSYSTEM=="video4linux", BUS=="usb"
  gpu-labels:
    - label: gpu-all
      max-number-gpus: 1
      all: true
  system-volumes:
    - name: daemon-socket
      path: /var/run/my-daemon.sock
      mode: read-only