Call Home Settings

Call Home Server settings.

Update the 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
enable-unclaimed
boolean
Default: false

When enabled the call-home server saves the most recent hosts that called home but that were not assigned to any sites.

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/call-home/settings
Request samples
client-certificate:
  verify: certificate-only
enable-unclaimed: true

Delete the 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/call-home/settings

Replace or create the 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
enable-unclaimed
boolean
Default: false

When enabled the call-home server saves the most recent hosts that called home but that were not assigned to any sites.

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/call-home/settings
Request samples
client-certificate:
  verify: certificate-only
enable-unclaimed: true

Retrieve the configuration of 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/call-home/settings
Response samples
client-certificate:
  verify: certificate-only
enable-unclaimed: true

Retrieve the the state of settings

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

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/call-home/settings
Response samples
client-certificate:
  verify: certificate-only
enable-unclaimed: true