Powered by Redocly

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

When enabled, the call-home server saves information about recent hosts that have called home with an unknown host-id. An unknown host-id is either a host-id that is not currently assigned to any site (unclaimed), or a host-id matching an existing host that has already completed the call-home sequence (duplicate).

Information about these hosts is stored in separate ring buffers in memory (one for unclaimed, one for duplicates). When a buffer is full (see max-unclaimed and max-duplicates below), the oldest entry is dropped.

max-unclaimed
integer <uint64>
Default: 20

Valid when: ../enable-unclaimed = "true"

The maximum number of unclaimed hosts to keep in memory.

max-duplicates
integer <uint64>
Default: 20

Valid when: ../enable-unclaimed = "true"

The maximum number of duplicate hosts to keep in memory.

object

Challenge-response authentication for host-init using x509 certificate.

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 
enable-unclaimed: true
max-unclaimed: 20
max-duplicates: 20

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

When enabled, the call-home server saves information about recent hosts that have called home with an unknown host-id. An unknown host-id is either a host-id that is not currently assigned to any site (unclaimed), or a host-id matching an existing host that has already completed the call-home sequence (duplicate).

Information about these hosts is stored in separate ring buffers in memory (one for unclaimed, one for duplicates). When a buffer is full (see max-unclaimed and max-duplicates below), the oldest entry is dropped.

max-unclaimed
integer <uint64>
Default: 20

Valid when: ../enable-unclaimed = "true"

The maximum number of unclaimed hosts to keep in memory.

max-duplicates
integer <uint64>
Default: 20

Valid when: ../enable-unclaimed = "true"

The maximum number of duplicate hosts to keep in memory.

object

Challenge-response authentication for host-init using x509 certificate.

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 
enable-unclaimed: true
max-unclaimed: 20
max-duplicates: 20

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 
enable-unclaimed: true
max-unclaimed: 20
max-duplicates: 20

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 
enable-unclaimed: true
max-unclaimed: 20
max-duplicates: 20
➔ Next to Call Home Stats