Powered by Redocly

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
resource-profile
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

Reference to the top level hardware resource profile used for all hosts in all sites. This profile may be overridden by hardware resource profiles configured on specific sites or specific hosts.

Array of objects
Array of objects
Array of all (object) or gpu-patterns (object)
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:
  application-owner-location-resolution: 2
resource-profile: generic-host
system-volumes:
  - name: daemon-socket
    path: /var/run/my-daemon.sock
device-labels:
  - label: video-dev
    udev-patterns:
      - SUBSYSTEM=="video4linux", BUS=="usb"
gpu-labels:
  - label: gpu-all
    max-number-gpus: 1
    all: true

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
resource-profile
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

Reference to the top level hardware resource profile used for all hosts in all sites. This profile may be overridden by hardware resource profiles configured on specific sites or specific hosts.

Array of objects
Array of objects
Array of all (object) or gpu-patterns (object)
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:
  application-owner-location-resolution: 2
resource-profile: generic-host
system-volumes:
  - name: daemon-socket
    path: /var/run/my-daemon.sock
device-labels:
  - label: video-dev
    udev-patterns:
      - SUBSYSTEM=="video4linux", BUS=="usb"
gpu-labels:
  - label: gpu-all
    max-number-gpus: 1
    all: true

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:
  application-owner-location-resolution: 2
resource-profile: generic-host
system-volumes:
  - name: daemon-socket
    path: /var/run/my-daemon.sock
device-labels:
  - label: video-dev
    udev-patterns:
      - SUBSYSTEM=="video4linux", BUS=="usb"
gpu-labels:
  - label: gpu-all
    max-number-gpus: 1
    all: true

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:
  application-owner-location-resolution: 2
resource-profile: generic-host
system-volumes:
  - name: daemon-socket
    path: /var/run/my-daemon.sock
device-labels:
  - label: video-dev
    udev-patterns:
      - SUBSYSTEM=="video4linux", BUS=="usb"
gpu-labels:
  - label: gpu-all
    max-number-gpus: 1
    all: true
➔ Next to Call Home Hosts