Datacenter API

GET/api/datacenter/check-cooling-contract

request access

Datacenter check cooling endpoint.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/check-cooling-contract

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/datacenter/check-cooling-contract?site=<site>'

GET/api/datacenter/check-power-contract

request access

Datacenter check power endpoint.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/check-power-contract

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/datacenter/check-power-contract?site=<site>'

GET/api/datacenter/check-rack-space-contract

request access

Datacenter check rack space endpoint.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/check-rack-space-contract

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/datacenter/check-rack-space-contract?site=<site>'

GET/api/datacenter/check-switchports-contract

request access

Datacenter check switchports endpoint.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/check-switchports-contract

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/datacenter/check-switchports-contract?site=<site>'

GET/api/datacenter/failing-checks-contract

request access

Datacenter failing checks endpoint.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/failing-checks-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/datacenter/failing-checks-contract'

GET/api/datacenter/firmware-contract

request access

Firmware contract.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/firmware-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/datacenter/firmware-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,
  "liveExecutionEnabled": false,
  "reviewerDesignation": null,
  "endpoints": []
}

POST/api/datacenter/firmware/check/{id}

execute access

Firmware check compliance.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/firmware/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

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/datacenter/firmware/check/<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>",
  "device_id": null,
  "site": null,
  "vendor": null,
  "model": null,
  "current_version": null,
  "minimum_version": null,
  "latest_version": null,
  "eol_date": null,
  "compliance_status": null,
  "meets_minimum": null,
  "latest_available": null
}

GET/api/datacenter/firmware/device/{id}

audit access

Get firmware device.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/firmware/device/{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/datacenter/firmware/device/<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>",
  "device": null
}

GET/api/datacenter/firmware/devices

audit access

List firmware devices.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/firmware/devices

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/datacenter/firmware/devices'

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>",
  "site": null,
  "count": null,
  "total": null,
  "limit": null,
  "offset": null,
  "devices": null
}

GET/api/datacenter/firmware/eol

audit access

Firmware eol.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/firmware/eol

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/datacenter/firmware/eol'

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

POST/api/datacenter/firmware/exception

execute access

Firmware request exception.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/firmware/exception

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: FirmwareExceptionRequest.

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 '{"deviceId":"<string>","reason":"<string>","expiryDays":0}' \
  'https://<your-host>/api/datacenter/firmware/exception'

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>",
  "exception": null,
  "device_status": null
}

POST/api/datacenter/firmware/exception/{id}/approve

approve access

Firmware approve exception.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/firmware/exception/{id}/approve

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: FirmwareExceptionApprovalRequest.

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 '{"expectedVersion":0}' \
  'https://<your-host>/api/datacenter/firmware/exception/<id>/approve'

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>",
  "exception": null,
  "device_status": null
}

GET/api/datacenter/firmware/exceptions

audit access

List firmware exceptions.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/firmware/exceptions

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/datacenter/firmware/exceptions'

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

GET/api/datacenter/firmware/noncompliant

audit access

Firmware noncompliant.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/firmware/noncompliant

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/datacenter/firmware/noncompliant'

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

GET/api/datacenter/firmware/report

audit access

Firmware compliance report.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/firmware/report

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/datacenter/firmware/report'

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>",
  "total": null,
  "compliant": null,
  "noncompliant": null,
  "eol": null,
  "exception": null,
  "dry_run": false
}

POST/api/datacenter/firmware/revoke/{id}

approve access

Firmware revoke exception.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/firmware/revoke/{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/datacenter/firmware/revoke/<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>",
  "revoked_exception_id": null,
  "device_id": null,
  "device_status": null
}

GET/api/datacenter/firmware/vendor-summary

audit access

Firmware vendor summary.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/firmware/vendor-summary

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/datacenter/firmware/vendor-summary'

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

GET/api/datacenter/full-readiness-contract

request access

Datacenter full readiness endpoint.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/full-readiness-contract

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/datacenter/full-readiness-contract?site=<site>'

GET/api/datacenter/hardware-contract

request access

Hardware contract.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/hardware-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/datacenter/hardware-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>",
  "lifecycleMode": "<string>",
  "providerCallsEnabled": false,
  "liveExecutionAllowed": false,
  "serialNumbersAllowed": false,
  "supportedWorkflows": [],
  "validVendors": [],
  "validModels": [],
  "lifecycleStates": [],
  "supportStatuses": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

POST/api/datacenter/hardware/add

execute access

Hardware add.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/hardware/add

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: HardwareAddRequest.

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 '{"vendor":"<string>","model":"<string>","site":"<string>","cluster":"<string>","serial":"<string>","warrantyExpiry":"<string>"}' \
  'https://<your-host>/api/datacenter/hardware/add'

POST/api/datacenter/hardware/firmware-check/{id}

execute access

Hardware firmware check.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/hardware/firmware-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/datacenter/hardware/firmware-check/<id>'

GET/api/datacenter/hardware/firmware-gaps

audit access

Hardware firmware gaps.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/hardware/firmware-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/datacenter/hardware/firmware-gaps'

GET/api/datacenter/hardware/inventory

audit access

Hardware inventory.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/hardware/inventory

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/datacenter/hardware/inventory'

GET/api/datacenter/hardware/lifecycle-report

audit access

Hardware lifecycle report.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/hardware/lifecycle-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/datacenter/hardware/lifecycle-report'

GET/api/datacenter/hardware/refresh-plan

audit access

Plan hardware refresh.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/hardware/refresh-plan

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/datacenter/hardware/refresh-plan'

GET/api/datacenter/hardware/support-risk

audit access

Hardware support risk.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/hardware/support-risk

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/datacenter/hardware/support-risk'

POST/api/datacenter/hardware/update-firmware/{id}

execute access

Hardware update firmware.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/hardware/update-firmware/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: HardwareUpdateFirmwareRequest.

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 '{"version":"<string>"}' \
  'https://<your-host>/api/datacenter/hardware/update-firmware/<id>'

GET/api/datacenter/hardware/warranty-expiring

audit access

Hardware warranty expiring.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/hardware/warranty-expiring

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/datacenter/hardware/warranty-expiring'

GET/api/datacenter/image-factory-contract

request access

Image factory contract.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/image-factory-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/datacenter/image-factory-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,
  "liveExecutionAllowed": false,
  "supportedWorkflows": [],
  "imageStatuses": [],
  "testPhases": [],
  "validOsFamilies": [],
  "requiredInputs": [],
  "requiredGuards": [],
  "blockedReasons": [],
  "requiredEvidence": [],
  "rules": []
}

GET/api/datacenter/image-factory/active/{site}

audit access

Image factory active.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/image-factory/active/{site}

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/datacenter/image-factory/active/<site>'

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

{
  "site": null,
  "active_count": null,
  "active_by_os": null
}

GET/api/datacenter/image-factory/history/{site}

audit access

Image factory history.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/image-factory/history/{site}

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/datacenter/image-factory/history/<site>'

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

{
  "site": null,
  "build_count": null,
  "builds": null
}

POST/api/datacenter/image-factory/initiate-build

execute access

Image factory initiate build.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/image-factory/initiate-build

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ImageFactoryBuildBody.

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 '{"image_name":"<string>","os_family":"<string>","distro":"<string>","version":"<string>","site":"<string>"}' \
  'https://<your-host>/api/datacenter/image-factory/initiate-build'

POST/api/datacenter/image-factory/promote/{id}

approve access

Image factory promote.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/image-factory/promote/{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/datacenter/image-factory/promote/<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

{
  "image": null,
  "superseded": null
}

POST/api/datacenter/image-factory/reject/{id}

approve access

Reject image factory.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/image-factory/reject/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ImageFactoryRejectBody.

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 '{"reason":"<string>"}' \
  'https://<your-host>/api/datacenter/image-factory/reject/<id>'

POST/api/datacenter/image-factory/run-tests/{id}

execute access

Image factory run tests.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/image-factory/run-tests/{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/datacenter/image-factory/run-tests/<id>'

POST/api/datacenter/image-factory/schedule-monthly

execute access

Image factory schedule monthly.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/image-factory/schedule-monthly

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: ImageFactoryScheduleBody.

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 '{"site":"<string>","os_family":"<string>","distro":"<string>"}' \
  'https://<your-host>/api/datacenter/image-factory/schedule-monthly'

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

{
  "scheduled": false,
  "cadence": "<string>",
  "image": null
}

GET/api/datacenter/image-factory/superseded

audit access

Image factory superseded.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/image-factory/superseded

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/datacenter/image-factory/superseded'

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

{
  "superseded_count": null,
  "images": null,
  "total": null,
  "limit": null,
  "offset": null
}

GET/api/datacenter/network-contract

request access

Network contract.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/network-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/datacenter/network-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,
  "liveNetworkChangesAllowed": false,
  "rawInventoryRowsAllowed": false,
  "networkIdentifiersAllowed": false,
  "dataReadPermission": "<string>",
  "dryRunRequired": false,
  "allowedResponseConcepts": [],
  "workflows": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "endpoints": null
}

GET/api/datacenter/network/capacity

admin access

Network capacity.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/network/capacity

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/datacenter/network/capacity'

GET/api/datacenter/network/ports

admin access

Network ports inventory.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/network/ports

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/datacenter/network/ports'

GET/api/datacenter/network/readiness

admin access

Network readiness check.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/network/readiness

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/datacenter/network/readiness'

POST/api/datacenter/network/release/{id}

execute access

Network release.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/network/release/{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/datacenter/network/release/<id>'

POST/api/datacenter/network/reserve-ips

execute access

Network reserve ips.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/network/reserve-ips

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: NetworkReserveIpsRequest.

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>","vlan_id":0,"count":0,"purpose":"<string>"}' \
  'https://<your-host>/api/datacenter/network/reserve-ips'

POST/api/datacenter/network/reserve-ports

execute access

Network reserve ports.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/network/reserve-ports

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Request body

JSON structure: NetworkReservePortsRequest.

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>","count":0,"purpose":"<string>"}' \
  'https://<your-host>/api/datacenter/network/reserve-ports'

GET/api/datacenter/network/vlans

admin access

Network vlans inventory.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/network/vlans

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/datacenter/network/vlans'

GET/api/datacenter/oob-contract

request access

Oob contract.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/oob-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/datacenter/oob-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,
  "liveAccessChecksAllowed": false,
  "liveCertificateChecksAllowed": false,
  "rawInventoryRowsAllowed": false,
  "endpointIdentifiersAllowed": false,
  "serialNumbersAllowed": false,
  "dryRunRequired": false,
  "supportedConsoleTypes": [],
  "workflows": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": [],
  "endpoints": null
}

GET/api/datacenter/oob/cert-expiring

audit access

Oob cert expiring.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/oob/cert-expiring

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/datacenter/oob/cert-expiring'

POST/api/datacenter/oob/check-defaults/{id}

execute access

Oob check defaults.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/oob/check-defaults/{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/datacenter/oob/check-defaults/<id>'

GET/api/datacenter/oob/failing

audit access

Oob failing.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/oob/failing

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/datacenter/oob/failing'

GET/api/datacenter/oob/firmware-outdated

audit access

Oob firmware outdated.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/oob/firmware-outdated

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/datacenter/oob/firmware-outdated'

GET/api/datacenter/oob/inventory

audit access

Oob inventory.

Permissions

HTTP request

GET https://<your-host>/api/datacenter/oob/inventory

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/datacenter/oob/inventory'

POST/api/datacenter/oob/test/{id}

execute access

Oob test endpoint.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/oob/test/{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/datacenter/oob/test/<id>'

POST/api/datacenter/oob/validate-cert/{id}

execute access

Oob validate cert.

Permissions

HTTP request

POST https://<your-host>/api/datacenter/oob/validate-cert/{id}

Path parameters

Query parameters

This operation has no query parameters.

Request headers