Mute many nodes at once (ADR-124 Inc.11) — the mute twin of the bulk window above, and a separate route because it asks for a different permission: muting is `AckAlerts`, opening a window is `ManageMaintenance`. Folding the two into one endpoint would mean picking one of them for both.

POST

/api/v1/mutes/bulk

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

Authorizations

• bearer

Request Body^required

Media typeapplication/json

Mute each of many nodes until one moment.

object

metric_name

string | null

node_ids

required

Array<string>

reason

string | null

until

required

string

Example^generated

{
  "metric_name": "example",
  "node_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "reason": "example",
  "until": "example"
}

Responses

200

How many mutes were created

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

An unparseable or past until, an illegal metric name, 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 AckAlerts

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"
  }
}