CMDB API

GET/api/cmdb/cis/{ci_name}

audit access

Read one configuration item from the REAL configuration_items table by its unique ci_name (#18).

The FIRST authenticated, DB-backed CMDB read — the impact/export endpoints serve an in-memory mock. AUDIT-tier (an explicit check, NOT the central gate's looser audit OR request): CI criticality and owner are inventory signals, kept audit-grade. Site/environment scope is applied in SQL through the exact active site-registry relation (out-of-scope → 404, no oracle). 503 with no DB (the table is the only CI source). NOTE: a ci_name containing / will not route as one path segment (404) — a by-UUID variant (the response carries id) is the follow-up for such names.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/cis/{ci_name}

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/cmdb/cis/<ci_name>'

GET/api/cmdb/export

audit access

Cmdb export records.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/export

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/cmdb/export'

GET/api/cmdb/impact-analysis-contract

request access

Cmdb impact analysis.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/impact-analysis-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/cmdb/impact-analysis-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,
  "domains": [],
  "impactSignals": [],
  "qualitySignals": [],
  "syncStates": [],
  "requiredGuards": [],
  "blockedReasons": []
}

GET/api/cmdb/impact-contract

request access

Cmdb impact contract.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/impact-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/cmdb/impact-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>",
  "impactEngineMode": "<string>",
  "providerCallsEnabled": false,
  "liveCmdbMutationAllowed": false,
  "liveRelationshipMutationAllowed": false,
  "endpoints": null,
  "ciTypes": [],
  "criticalityLevels": [],
  "riskLevels": [],
  "requiredGuards": [],
  "blockedReasons": []
}

POST/api/cmdb/impact/analyze

execute access

Cmdb impact analyze.

Permissions

HTTP request

POST https://<your-host>/api/cmdb/impact/analyze

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: serde_json::Value.

This operation accepts JSON, but its field schema is not available. The known body type is serde_json::Value. No object shape is fabricated.

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-binary '@request.json' \
  'https://<your-host>/api/cmdb/impact/analyze'

GET/api/cmdb/impact/downstream/{ci_name}

audit access

Cmdb impact downstream.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/impact/downstream/{ci_name}

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/cmdb/impact/downstream/<ci_name>'

GET/api/cmdb/impact/graph

audit access

Cmdb impact graph.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/impact/graph

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/cmdb/impact/graph'

GET/api/cmdb/impact/upstream/{ci_name}

audit access

Cmdb impact upstream.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/impact/upstream/{ci_name}

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/cmdb/impact/upstream/<ci_name>'

POST/api/cmdb/import

execute access

Cmdb import records.

Permissions

HTTP request

POST https://<your-host>/api/cmdb/import

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: CmdbImportRequest.

Response

For 200, the known response body type is Vec<ryuki_engine::models::CmdbRecord>. 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 '{"source":"<string>"}' \
  'https://<your-host>/api/cmdb/import'

POST/api/cmdb/reconcile

execute access

Cmdb run reconciliation.

Permissions

HTTP request

POST https://<your-host>/api/cmdb/reconcile

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

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>",
  "reconciliation_results": null,
  "attribute_drift": null
}

GET/api/cmdb/reconciliation-contract

request access

Cmdb reconciliation.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/reconciliation-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/cmdb/reconciliation-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": [],
  "decisions": [],
  "requiredGuards": [],
  "blockedReasons": []
}

GET/api/cmdb/relationship-graph-contract

request access

Cmdb relationship graph.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/relationship-graph-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/cmdb/relationship-graph-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,
  "nodeTypes": [],
  "edgeTypes": [],
  "requiredGuards": [],
  "blockedReasons": []
}

GET/api/cmdb/servicenow-contract

request access

Servicenow contract.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/servicenow-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/cmdb/servicenow-contract'

POST/api/cmdb/servicenow/approve/{id}

execute access

Approve servicenow.

Permissions

HTTP request

POST https://<your-host>/api/cmdb/servicenow/approve/{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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/cmdb/servicenow/approve/<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

{
  "id": null,
  "status": "<string>",
  "approved_at": null,
  "source": "<string>",
  "note": "<string>"
}

POST/api/cmdb/servicenow/cancel/{id}

execute access

Cancel servicenow.

Permissions

HTTP request

POST https://<your-host>/api/cmdb/servicenow/cancel/{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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/cmdb/servicenow/cancel/<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

{
  "id": null,
  "status": "<string>",
  "cancelled_at": null,
  "source": "<string>"
}

POST/api/cmdb/servicenow/change

execute access

Servicenow change.

Permissions

HTTP request

POST https://<your-host>/api/cmdb/servicenow/change

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ServicenowChangeRequest.

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 '{"ciName":"<string>","changeType":"<string>","description":"<string>","plannedStart":"<string>","plannedEnd":"<string>","risk":"<string>"}' \
  'https://<your-host>/api/cmdb/servicenow/change'

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

{
  "id": null,
  "request_type": "<string>",
  "ci_name": null,
  "site": null,
  "environment": null,
  "status": "<string>",
  "payload_summary": null,
  "created_at": null,
  "source": "<string>"
}

GET/api/cmdb/servicenow/history/{ci}

audit access

Servicenow history.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/servicenow/history/{ci}

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/cmdb/servicenow/history/<ci>'

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>",
  "ci_name": null,
  "count": null,
  "items": null
}

POST/api/cmdb/servicenow/incident

execute access

Servicenow incident.

Permissions

HTTP request

POST https://<your-host>/api/cmdb/servicenow/incident

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ServicenowIncidentRequest.

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 '{"ciName":"<string>","description":"<string>","urgency":"<string>","assignmentGroup":"<string>"}' \
  'https://<your-host>/api/cmdb/servicenow/incident'

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

{
  "id": null,
  "request_type": "<string>",
  "ci_name": null,
  "site": null,
  "environment": null,
  "status": "<string>",
  "payload_summary": null,
  "created_at": null,
  "source": "<string>"
}

GET/api/cmdb/servicenow/pending

audit access

Servicenow pending.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/servicenow/pending

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/cmdb/servicenow/pending'

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>",
  "count": null,
  "items": null
}

POST/api/cmdb/servicenow/request

execute access

Servicenow request.

Permissions

HTTP request

POST https://<your-host>/api/cmdb/servicenow/request

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ServicenowRequestRequest.

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 '{"ciName":"<string>","requestType":"<string>","description":"<string>"}' \
  'https://<your-host>/api/cmdb/servicenow/request'

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

{
  "id": null,
  "request_type": "<string>",
  "ci_name": null,
  "site": null,
  "environment": null,
  "status": "<string>",
  "payload_summary": null,
  "created_at": null,
  "source": "<string>"
}

GET/api/cmdb/servicenow/status/{id}

audit access

Servicenow status.

Permissions

HTTP request

GET https://<your-host>/api/cmdb/servicenow/status/{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/cmdb/servicenow/status/<id>'

POST/api/cmdb/servicenow/submit/{id}

execute access

Servicenow submit.

Permissions

HTTP request

POST https://<your-host>/api/cmdb/servicenow/submit/{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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/cmdb/servicenow/submit/<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

{
  "id": null,
  "status": "<string>",
  "queued_at": null,
  "source": "<string>",
  "note": "<string>"
}

POST/api/cmdb/servicenow/validate/{id}

execute access

Validate servicenow.

Permissions

HTTP request

POST https://<your-host>/api/cmdb/servicenow/validate/{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 POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/cmdb/servicenow/validate/<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

{
  "id": null,
  "status": "<string>",
  "passed": false,
  "errors": [],
  "warnings": [],
  "source": "<string>"
}