Monitoring API

GET/api/monitoring/alert-routes

audit access

List alert routes.

Permissions

HTTP request

GET https://<your-host>/api/monitoring/alert-routes

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/monitoring/alert-routes'

POST/api/monitoring/alert-routes

monitoring.alert-routing.manage access

Create alert routes.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/alert-routes

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: AlertRouteCreateRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"site":"<string>","environment":"<string>","triggerName":"<string>","severity":"<string>","hostGroup":"<string>","supportGroup":"<string>","priority":"<string>"}' \
  'https://<your-host>/api/monitoring/alert-routes'

DELETE/api/monitoring/alert-routes/{id}

monitoring.alert-routing.manage access

Delete alert routes.

Permissions

HTTP request

DELETE https://<your-host>/api/monitoring/alert-routes/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request DELETE \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/monitoring/alert-routes/<id>'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "deleted": false,
  "id": null
}

GET/api/monitoring/alert-routes/{id}

audit access

Get alert routes.

Permissions

HTTP request

GET https://<your-host>/api/monitoring/alert-routes/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/monitoring/alert-routes/<id>'

PUT/api/monitoring/alert-routes/{id}

monitoring.alert-routing.manage access

Update alert routes.

Permissions

HTTP request

PUT https://<your-host>/api/monitoring/alert-routes/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: AlertRouteUpdateRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request PUT \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{}' \
  'https://<your-host>/api/monitoring/alert-routes/<id>'

GET/api/monitoring/alert-routing-contract

request access

Monitoring alert routing contract.

Permissions

HTTP request

GET https://<your-host>/api/monitoring/alert-routing-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/monitoring/alert-routing-contract'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "liveRoutingAllowed": false,
  "dryRunRequired": false,
  "supportedWorkflows": [],
  "routeDimensions": [],
  "validSeverities": [],
  "validPriorities": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

POST/api/monitoring/alerts/resolve

execute access

Alert resolve.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/alerts/resolve

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: AlertResolveRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"site":"<string>","environment":"<string>","triggerName":"<string>","severity":"<string>","hostGroup":"<string>"}' \
  'https://<your-host>/api/monitoring/alerts/resolve'

GET/api/monitoring/alerts/unrouted

audit access

Alert unrouted.

Permissions

HTTP request

GET https://<your-host>/api/monitoring/alerts/unrouted

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/monitoring/alerts/unrouted'

GET/api/monitoring/noise-contract

request access

Noise contract.

Permissions

HTTP request

GET https://<your-host>/api/monitoring/noise-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/monitoring/noise-contract'

POST/api/monitoring/noise/detect

execute access

Noise detect.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/noise/detect

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: NoiseSiteRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"site":"<string>"}' \
  'https://<your-host>/api/monitoring/noise/detect'

POST/api/monitoring/noise/flapping

execute access

Noise flapping detect.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/noise/flapping

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: NoiseSiteRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"site":"<string>"}' \
  'https://<your-host>/api/monitoring/noise/flapping'

GET/api/monitoring/noise/report

audit access

Noise report.

Permissions

HTTP request

GET https://<your-host>/api/monitoring/noise/report

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/monitoring/noise/report'

POST/api/monitoring/noise/resolve/{id}

execute access

Noise resolve.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/noise/resolve/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: NoiseResolveRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"resolution":"<string>"}' \
  'https://<your-host>/api/monitoring/noise/resolve/<id>'

POST/api/monitoring/noise/suggest/{id}

execute access

Noise suggest.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/noise/suggest/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/monitoring/noise/suggest/<id>'

POST/api/monitoring/noise/suppress/{id}

execute access

Noise suppress.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/noise/suppress/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: NoiseSuppressRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"duration_minutes":0,"reason":"<string>"}' \
  'https://<your-host>/api/monitoring/noise/suppress/<id>'

GET/api/monitoring/noise/suppressed

audit access

Suppressed triggers paged after the persisted canonical-site filter.

Quarantined rows are omitted from both the page and total, including for otherwise-unrestricted principals.

Permissions

HTTP request

GET https://<your-host>/api/monitoring/noise/suppressed

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

200 response headers

Returns a bare JSON array; the filtered total is exposed via the X-Total-Count response header.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/monitoring/noise/suppressed'

GET/api/monitoring/zabbix-drift-contract

request access

Zabbix drift contract.

Permissions

HTTP request

GET https://<your-host>/api/monitoring/zabbix-drift-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/monitoring/zabbix-drift-contract'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "liveRemediationAllowed": false,
  "zabbixMutationAllowed": false,
  "rawEventPayloadsAllowed": false,
  "dryRunRequired": false,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "endpoints": null
}

GET/api/monitoring/zabbix/drift

audit access

Zabbix drift summary.

Permissions

HTTP request

GET https://<your-host>/api/monitoring/zabbix/drift

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/monitoring/zabbix/drift'

POST/api/monitoring/zabbix/drift/detect

execute access

Zabbix drift detect.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/zabbix/drift/detect

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ZabbixDriftSiteRequest.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"site":"<string>"}' \
  'https://<your-host>/api/monitoring/zabbix/drift/detect'

POST/api/monitoring/zabbix/drift/execute/{drift_id}

execute access

Execute zabbix drift.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/zabbix/drift/execute/{drift_id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/monitoring/zabbix/drift/execute/<drift_id>'

POST/api/monitoring/zabbix/drift/plan/{drift_id}

execute access

Plan zabbix drift.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/zabbix/drift/plan/{drift_id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/monitoring/zabbix/drift/plan/<drift_id>'

POST/api/monitoring/zabbix/drift/validate/{drift_id}

execute access

Validate zabbix drift.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/zabbix/drift/validate/{drift_id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/monitoring/zabbix/drift/validate/<drift_id>'

POST/api/monitoring/zabbix/drift/verify/{drift_id}

execute access

Verify zabbix drift.

Permissions

HTTP request

POST https://<your-host>/api/monitoring/zabbix/drift/verify/{drift_id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

This operation does not accept a request body.

Response

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/monitoring/zabbix/drift/verify/<drift_id>'