Open a maintenance window over each of many nodes at once (ADR-124 Inc.11).

POST

/api/v1/maintenance-windows/bulk

curl --request POST \
  --url https://example.com/api/v1/maintenance-windows/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ends_at": "example", "name": "example", "node_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "starts_at": "example" }'

“This dozen, tonight” rarely follows a folder boundary, so the folder-scoped window cannot express it and the single-node form meant one request each.

One window per node rather than one window naming many: a window’s scope is a single id (migration 0011), and widening that is a schema change the alert engine, the suppression index and list_suppressions all read.

⚠️ Only the node level. The class levels (profile, group) already reach many nodes by naming a class, and the folder level reaches a subtree — a batch of ids is the case none of them covers. The scope check is therefore the node one, applied by the store’s JOIN nodes rather than a pre-check, so a node deleted between the check and the write cannot get a window.

Authorizations

• bearer

Request Body^required

Media typeapplication/json

Open one window over each of many nodes.

object

ends_at

required

string

name

required

string

node_ids

required

Array<string>

starts_at

required

string

Example^generated

{
  "ends_at": "example",
  "name": "example",
  "node_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "starts_at": "example"
}

Responses

200

How many windows were opened

Media typeapplication/json

What a bulk suppression write actually did. Shared by the window and the mute form: they answer the same question and a second shape would be two names for one fact.

object

created

required

Rows actually written. Lower than requested is normal: an id can name a node that has since been deleted, or one outside the caller’s scope. The two are not distinguished.

integer format: int64

requested

required

Distinct node ids the request named, after de-duplication.

integer

Example^generated

{
  "created": 1,
  "requested": 1
}

400

Empty name, unparseable or backwards bounds, or more ids than one request may carry

Media typeapplication/json

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

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

No valid bearer token

Media typeapplication/json

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

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role lacks ManageMaintenance

Media typeapplication/json

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

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

This core has no write side (skeleton mode)

Media typeapplication/json

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

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}