Developers
Configuration3

Validate a configuration manifest

POST/configuration/validations

Validates a configuration manifest without modifying any resource.

Content problems, such as invalid fields, unresolved references, or incomplete ordered sets (order_set_mismatch), are reported in the validation report, and the response status is still 200. Check the valid field to determine the result.

The request is rejected with 422 only when the manifest cannot be evaluated: too_many_items when it exceeds the maximum number of resources, and unsupported_resource when it contains an unsupported resource kind.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A declarative configuration manifest document (cademi/configuration-manifest/v1). Supported resource kinds are showcase, product, module, lesson, banner, menu_item, settings, webhook, and custom_code.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/configuration/validations" \  -H "Content-Type: application/json" \  -d '{    "resources": [      {        "kind": "showcase",        "ref": "string"      }    ]  }'
{  "data": {    "errors": [      {        "code": "string",        "message": "string",        "path": "string"      }    ],    "object": "validation",    "required_capabilities": [      "string"    ],    "unsupported": [      "string"    ],    "valid": true,    "warnings": [      {        "code": "string",        "path": "string"      }    ]  }}

Create a configuration plan POST

Calculates the steps required to bring the account to the state described in a configuration manifest, and returns them as a signed plan. This operation is synchronous and does not modify any resource. The plan expires 24 hours after it is created, as indicated by `expires_at`. To apply it, submit the plan to the apply operation before it expires. If the manifest is invalid, the API returns `validation_failed` with the same error codes reported by the validation operation, and no plan is created.

Tickets9

Next Page