Turn acceptance of remote-site pollers on or off.
const url = 'https://example.com/api/v1/settings/bus/remote';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"enabled":true,"names":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/api/v1/settings/bus/remote \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "enabled": true, "names": [ "example" ] }'The bus, this core and the co-located poller are all recreated, so monitoring stops for as long as that takes. A fleet-wide maintenance window is opened first.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Turn acceptance of remote-site pollers on or off.
object
true encrypts and authenticates the bus and publishes its port; false returns it to the
internal-only plaintext bus and stops every remote poller from connecting.
Hostnames and IP addresses remote pollers will dial. Used to reissue the certificate before the bus restarts, so the names are already right when it comes back. Ignored when disabling.
Examplegenerated
{ "enabled": true, "names": [ "example" ]}Responses
Section titled “Responses”Accepted; the bus is being recreated and this core will restart
What the switch returns. The poller secret appears once.
object
The certificate a remote poller must pin as its YAGRA_BUS_CA_FILE, in PEM. null when
disabling.
Identifier for this change, matching the run reported by the upgrade status endpoint.
The fleet-wide maintenance window opened for the duration, or null if one could not be
opened. Monitoring stops for as long as the bus is being recreated.
The bootstrap secret a remote poller presents when it connects, shown once. Store it now — it is written into the deployment’s environment and is never returned again.
Examplegenerated
{ "ca_certificate": "example", "id": "example", "maintenance_window_id": "example", "poller_secret": "example"}Enabling without an address remote pollers can dial
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}No valid bearer token
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}Role lacks ManageSystem
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}An upgrade or another bus change is already running
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}No updater is deployed, or it is switched off
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}