Update an org's per-tier cadence, enabled tiers, and rate budget.
const url = 'https://example.com/api/v1/meraki/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cadence';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"availability_secs":1,"enabled_tiers":["example"],"inventory_secs":1,"switch_ports_secs":1,"target_rps":1,"traffic_secs":1,"uplink_secs":1,"wireless_secs":1}'};
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/meraki/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cadence \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "availability_secs": 1, "enabled_tiers": [ "example" ], "inventory_secs": 1, "switch_ports_secs": 1, "target_rps": 1, "traffic_secs": 1, "uplink_secs": 1, "wireless_secs": 1 }'enabled_tiers must include availability. It is the one tier that decides whether a device
is up; the others only record readings, so an organization without it could raise no node-down
alert at all. switch_ports_secs and wireless_secs may be left out, and the stored interval
then stays.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Organization row id
Request Bodyrequired
Section titled “Request Bodyrequired”object
The switch-port tier’s interval, 300–600 seconds. Optional: left out, the stored interval stays as it is, so a client written before the tier existed does not reset it.
Requests per second this organization may be sent, in total (ADR-169). Its collects run in two lanes that can be asking at once — a fast one for availability, uplink, traffic and a wireless round, a slow one for the switch ports, the SSID read and the inventory sync (periodic, or asked for by “Sync now”) — and each paces at half of this. The one exception is the LAN reads of an organization with no node yet, which take all of it: nothing is collected for it, so the fast lane is idle. Below 0.2 each lane stops at 0.1, the slowest a session paces, so the two together can then send up to 0.2 whatever this says.
The wireless tier’s interval, 300–600 seconds. Optional, for the same reason.
Examplegenerated
{ "availability_secs": 1, "enabled_tiers": [ "example" ], "inventory_secs": 1, "switch_ports_secs": 1, "target_rps": 1, "traffic_secs": 1, "uplink_secs": 1, "wireless_secs": 1}Responses
Section titled “Responses”Cadence, enabled tiers and rate budget updated
A cadence value is outside its band (switch_ports_secs and wireless_secs 300–600), target_rps is outside the cap, a tier is unknown, or enabled_tiers leaves out availability (availability_required)
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 ManageConfig, or the account is restricted to folders (scope_unsupported)
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 such organization
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" }}Inventory storage is unavailable (skeleton mode)
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" }}