contracts

Apply Contract

Apply an ODCS YAML to an asset's live config.

Request body is raw YAML. Validation failures short-circuit before any DB touch; on success, the orchestrator opens a single transaction spanning every selected domain's import step.

post/api/v1/contracts/{asset_public_id}/apply

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/contracts/{asset_public_id}/apply
  • Auth: none declared

Path parameters

asset_public_idstring uuid required

Query parameters

pruneboolean

When true, existing state missing from the incoming YAML is deleted. Default false keeps the apply warn-only.

includestring nullable

Comma-separated domains to apply (others skipped).

excludestring nullable

Comma-separated domains to skip.

Headers

Authorizationstring

Response

Successful Response

successboolean required
dataunknown
messagestring nullable
errorstring nullable
metaobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.