Observe API

GET/api/observe/alert-routing-contract

request access

Observe alert routing.

Permissions

HTTP request

GET https://<your-host>/api/observe/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/observe/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,
  "workflows": [],
  "dimensions": [],
  "requiredGuards": [],
  "escalationStages": [],
  "blockedReasons": []
}

GET/api/observe/log-forwarder-onboarding-contract

request access

Observe log forwarder.

Permissions

HTTP request

GET https://<your-host>/api/observe/log-forwarder-onboarding-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/observe/log-forwarder-onboarding-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,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/observe/logs-contract

request access

Logs contract.

Permissions

HTTP request

GET https://<your-host>/api/observe/logs-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/observe/logs-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,
  "endpoints": null,
  "sourceTypes": [],
  "statuses": [],
  "hosts": null,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "blockedReasons": []
}

GET/api/observe/logs/coverage

audit access

Return the coverage report for a site.

Reads from DB when available. When no pool is connected the read degrades to an empty result (never seed data, which would mask missing persistence). A DB error propagates as 500.

Permissions

HTTP request

GET https://<your-host>/api/observe/logs/coverage

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/observe/logs/coverage?site=<site>'

POST/api/observe/logs/disable/{hostname}

execute access

Disable log forwarding for all sources on a hostname by transitioning each to NotConfigured.

Requires a database. Disables every still-active source for the hostname in one atomic, advisory-locked step (repos::log_forwarders::disable_all_for_hostname) so it cannot race a concurrent onboard or be left partially applied. The response lists the sources that were actually transitioned.

Permissions

HTTP request

POST https://<your-host>/api/observe/logs/disable/{hostname}

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/observe/logs/disable/<hostname>'

GET/api/observe/logs/gaps

audit access

Return the gap report for a site.

Reads from DB when available. When no pool is connected the read degrades to an empty result (never seed data, which would mask missing persistence). A DB error propagates as 500.

Permissions

HTTP request

GET https://<your-host>/api/observe/logs/gaps

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/observe/logs/gaps?site=<site>'

POST/api/observe/logs/onboard

execute access

Insert one LogSource row per requested source type and return the list of persisted records.

The handler fans out: one row per (hostname, source_type) pair so each source has an independent status lifecycle.

Permissions

HTTP request

POST https://<your-host>/api/observe/logs/onboard

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: LogsOnboardRequest.

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 '{"hostname":"<string>","site":"<string>"}' \
  'https://<your-host>/api/observe/logs/onboard'

GET/api/observe/logs/retention

audit access

Return the retention status for a site.

Reads from DB when available. When no pool is connected the read degrades to an empty result (never seed data, which would mask missing persistence). A DB error propagates as 500.

Permissions

HTTP request

GET https://<your-host>/api/observe/logs/retention

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/observe/logs/retention?site=<site>'

POST/api/observe/logs/validate/{hostname}

execute access

Validate the forwarding config for a hostname.

Reads from DB when available. When no pool is connected the read degrades to an empty result (never seed data, which would mask missing persistence). A DB error propagates as 500.

Permissions

HTTP request

POST https://<your-host>/api/observe/logs/validate/{hostname}

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/observe/logs/validate/<hostname>'

POST/api/observe/logs/verify/{hostname}

execute access

Verify that a hostname is actively forwarding logs.

Reads from DB when available. When no pool is connected the read degrades to an empty result (never seed data, which would mask missing persistence). A DB error propagates as 500.

Permissions

HTTP request

POST https://<your-host>/api/observe/logs/verify/{hostname}

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/observe/logs/verify/<hostname>'

GET/api/observe/logs/volume

audit access

Return the volume report for a site.

Reads from DB when available. When no pool is connected the read degrades to an empty result (never seed data, which would mask missing persistence). A DB error propagates as 500.

Permissions

HTTP request

GET https://<your-host>/api/observe/logs/volume

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/observe/logs/volume?site=<site>'

GET/api/observe/monitoring-coverage-gap-contract

request access

Observe monitoring coverage gap.

Permissions

HTTP request

GET https://<your-host>/api/observe/monitoring-coverage-gap-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/observe/monitoring-coverage-gap-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,
  "gapScopes": [],
  "gapSignals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/observe/monitoring-review-queue

request access

The LIVE monitoring review queue (#29).

The monitoring_review_queue table (migration 031) was seeded but never read by the API — only the static contract endpoint existed. This turns it into a real read surface, mirroring how shift_queue is exposed. Request-tier read, site-scoped (#2): a scoped principal sees only its own site's items; an environment-scoped principal sees none (this queue is site-only). Ordered by SLA deadline (most urgent first). Empty + durable:false when no DB is configured.

Permissions

HTTP request

GET https://<your-host>/api/observe/monitoring-review-queue

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Returns a paginated JSON object with total/limit/offset keys.

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/observe/monitoring-review-queue'

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

{
  "items": null,
  "durable": false,
  "total": null,
  "limit": null,
  "offset": null
}

GET/api/observe/monitoring-review-queue-contract

request access

Observe monitoring review queue.

Permissions

HTTP request

GET https://<your-host>/api/observe/monitoring-review-queue-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/observe/monitoring-review-queue-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,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/observe/noise-flapping-remediation-contract

request access

Observe noise flapping.

Permissions

HTTP request

GET https://<your-host>/api/observe/noise-flapping-remediation-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/observe/noise-flapping-remediation-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,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/observe/oncall/contacts

audit access

List contacts, optionally filtered by site and/or escalation tier, in escalation order.

Permissions

HTTP request

GET https://<your-host>/api/observe/oncall/contacts

Path parameters

This operation has no path parameters.

Query parameters

Request headers

Request body

This operation does not accept a request body.

Response

200 response body

Structure: Value.

Returns a paginated JSON object with total/limit/offset keys.

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/observe/oncall/contacts'

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

{
  "contacts": null,
  "durable": false,
  "total": null,
  "limit": null,
  "offset": null,
  "source": "<string>",
  "count": null
}

POST/api/observe/oncall/contacts

execute access

Register an on-call contact.

Execute-tier.

Permissions

HTTP request

POST https://<your-host>/api/observe/oncall/contacts

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: OnCallContactCreateRequest.

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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"name":"<string>","role":"<string>"}' \
  'https://<your-host>/api/observe/oncall/contacts'

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>",
  "id": null,
  "created": false
}

DELETE/api/observe/oncall/contacts/{id}

execute access

Remove a contact.

404 when unknown.

Permissions

HTTP request

DELETE https://<your-host>/api/observe/oncall/contacts/{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/observe/oncall/contacts/<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

{
  "source": "<string>",
  "deleted": false,
  "id": null
}

GET/api/observe/oncall/contacts/{id}

audit access

Fetch one contact.

Permissions

HTTP request

GET https://<your-host>/api/observe/oncall/contacts/{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 GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/observe/oncall/contacts/<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

{
  "source": "<string>",
  "contact": null
}

PUT/api/observe/oncall/contacts/{id}

execute access

Update a contact's mutable fields.

404 when unknown; 503 when no DB.

Permissions

HTTP request

PUT https://<your-host>/api/observe/oncall/contacts/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: OnCallContactUpdateRequest.

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 PUT \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{}' \
  'https://<your-host>/api/observe/oncall/contacts/<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

{
  "source": "<string>",
  "contact": null
}

GET/api/observe/synthetic-health-check-contract

request access

Observe synthetic health check contract.

Permissions

HTTP request

GET https://<your-host>/api/observe/synthetic-health-check-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/observe/synthetic-health-check-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>",
  "checkMode": "<string>",
  "dryRunRequired": false,
  "providerCallsEnabled": false,
  "liveChecksAllowed": false,
  "externalProbesAllowed": false,
  "zabbixMutationAllowed": false,
  "rawProbeOutputAllowed": false,
  "supportedWorkflows": [],
  "checkSignals": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/observe/synthetic/dashboard

audit access

Synthetic dashboard.

Permissions

HTTP request

GET https://<your-host>/api/observe/synthetic/dashboard

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/observe/synthetic/dashboard'

GET/api/observe/synthetic/outages

audit access

Synthetic outages.

Permissions

HTTP request

GET https://<your-host>/api/observe/synthetic/outages

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/observe/synthetic/outages'

POST/api/observe/synthetic/run-all

execute access

Synthetic run all.

Permissions

HTTP request

POST https://<your-host>/api/observe/synthetic/run-all

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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/observe/synthetic/run-all'

POST/api/observe/synthetic/run/{check_id}

execute access

Synthetic run check.

Permissions

HTTP request

POST https://<your-host>/api/observe/synthetic/run/{check_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/observe/synthetic/run/<check_id>'

GET/api/observe/synthetic/status/{check_id}

audit access

Synthetic status.

Permissions

HTTP request

GET https://<your-host>/api/observe/synthetic/status/{check_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/observe/synthetic/status/<check_id>'

GET/api/observe/zabbix-drift-remediation-contract

request access

Observe zabbix drift.

Permissions

HTTP request

GET https://<your-host>/api/observe/zabbix-drift-remediation-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/observe/zabbix-drift-remediation-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,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET/api/observe/zabbix-onboarding-contract

request access

Observe zabbix onboarding.

Permissions

HTTP request

GET https://<your-host>/api/observe/zabbix-onboarding-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/observe/zabbix-onboarding-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,
  "workflows": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}