Apply Resource

curl --request POST \
  --url https://api.example.com/resources/apply \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "resource": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "config": {},
  "dependencies": [],
  "owner_references": [],
  "outputs": {},
  "error": "<string>",
  "lifecycle_state": "draft",
  "pending_event_id": "<string>",
  "tags": [
    "<string>"
  ]
}
'

{
  "provider": "<string>",
  "resource": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "config": {},
  "dependencies": [],
  "owner_references": [],
  "outputs": {},
  "error": "<string>",
  "lifecycle_state": "draft",
  "pending_event_id": "<string>",
  "tags": [
    "<string>"
  ]
}

resources

Apply Resource

Apply a resource with declarative lifecycle semantics.

Set lifecycle_state in the resource:

lifecycle_state=“draft”: Store without processing (default)
lifecycle_state=“pending”: Validate dependencies and queue for processing

Cannot set PROCESSING, READY, FAILED (system-only states). Cannot modify resources in PENDING or PROCESSING state.

Returns: Applied resource with timestamps and server-populated fields.

Raises: HTTPException: 409 if lifecycle transition invalid or resource in processing. 422 if dependency validation or field reference resolution fails.

POST

resources

apply

Apply Resource

curl --request POST \
  --url https://api.example.com/resources/apply \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "resource": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "config": {},
  "dependencies": [],
  "owner_references": [],
  "outputs": {},
  "error": "<string>",
  "lifecycle_state": "draft",
  "pending_event_id": "<string>",
  "tags": [
    "<string>"
  ]
}
'

{
  "provider": "<string>",
  "resource": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "config": {},
  "dependencies": [],
  "owner_references": [],
  "outputs": {},
  "error": "<string>",
  "lifecycle_state": "draft",
  "pending_event_id": "<string>",
  "tags": [
    "<string>"
  ]
}

Body

application/json

Domain model for resources with provider/resource identity and 5-state lifecycle.

Identity fields (frozen - immutable after creation): provider: Provider that manages this resource type. resource: Resource type name. name: Unique resource instance name.

Configuration fields (mutable): config: Resource configuration dictionary. May contain embedded resource configurations if the provider schema defines fields as resource types. dependencies: References to resources this resource depends on. owner_references: References to resources that own this resource for lifecycle coordination and cascading deletes.

Output fields (provider-managed): outputs: Resource outputs from provider processing. error: Error message when resource is in FAILED state.

Lifecycle fields (system-managed): lifecycle_state: Current state (DRAFT/PENDING/PROCESSING/READY/FAILED). pending_event_id: Event ID currently being processed (set on PROCESSING, cleared on READY/FAILED). Used for response idempotency validation.

Categorization fields (mutable): tags: Optional list of tags for categorization and filtering.

Inherited from PragmaModel: created_at: Creation timestamp (frozen). updated_at: Last update timestamp (mutable).

provider

string

required

resource

string

required

name

string

required

created_at

string<date-time>

updated_at

string<date-time>

config

Config · object

dependencies

ResourceReference · object[]

Show child attributes

owner_references

OwnerReference · object[]

Show child attributes

outputs

Outputs · object

error

string | null

lifecycle_state

enum<string>

default:draft

Resource lifecycle states: DRAFT, PENDING, PROCESSING, READY, FAILED.

Available options:

draft,

pending,

processing,

ready,

failed

pending_event_id

string | null

Response

Successful Response

Domain model for resources with provider/resource identity and 5-state lifecycle.

Identity fields (frozen - immutable after creation): provider: Provider that manages this resource type. resource: Resource type name. name: Unique resource instance name.

Output fields (provider-managed): outputs: Resource outputs from provider processing. error: Error message when resource is in FAILED state.

Categorization fields (mutable): tags: Optional list of tags for categorization and filtering.

Inherited from PragmaModel: created_at: Creation timestamp (frozen). updated_at: Last update timestamp (mutable).

provider

string

required

resource

string

required

name

string

required

created_at

string<date-time>

updated_at

string<date-time>

config

Config · object

dependencies

ResourceReference · object[]

Show child attributes

owner_references

OwnerReference · object[]

Show child attributes

outputs

Outputs · object

error

string | null

lifecycle_state

enum<string>

default:draft

Resource lifecycle states: DRAFT, PENDING, PROCESSING, READY, FAILED.

Available options:

draft,

pending,

processing,

ready,

failed

pending_event_id

string | null

API

Body

Response