Skip to main content
DELETE
/
resources
/
by-name
Remove Resource
curl --request DELETE \
  --url https://api.example.com/resources/by-name
{
  "provider": "<string>",
  "resource": "<string>",
  "name": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "config": {},
  "resolved_config": {},
  "dependencies": [],
  "owner_references": [],
  "outputs": {},
  "error": "<string>",
  "lifecycle_state": "draft",
  "health": "healthy",
  "health_message": "<string>",
  "pending_event_id": "<string>",
  "pending_event_type": "<string>",
  "provisioned": false,
  "reconcile_count": 0,
  "version": 0,
  "tags": [
    "<string>"
  ],
  "provider_version": "<string>"
}

Query Parameters

​
provider
string
required

Provider name

​
resource
string
required

Resource type

​
name
string
required

Resource name

​
reveal
boolean
default:false

Reveal sensitive field values

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.

Configuration fields (mutable): config: Original user-submitted resource configuration. Contains raw field references and dependency markers as submitted by the user. resolved_config: Resolved configuration with field references and dependency markers expanded. Contains field_ref markers with resolved_value and dependency markers with ref data. Set when transitioning to PENDING state. None when resource is in DRAFT state or not yet resolved. 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. provisioned: Whether the resource was successfully created at least once. Used to distinguish failed creates (retry CREATE) from failed updates (retry UPDATE).

Versioning fields (system-managed): provider_version: Semver of the provider version that last processed this resource. Set automatically when the resource transitions to PENDING. None for platform resources or pre-versioning backfill.

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
​
id
string
required

External resource ID for API responses: provider/resource/name.

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
config
Config · object
​
resolved_config
Resolved Config · object
​
dependencies
ResourceReference · object[]
​
owner_references
OwnerReference · object[]
​
outputs
Outputs · object
​
error
string | null
​
lifecycle_state
enum<string>
default:draft

Lifecycle states for resources.

Available options:
draft,
waiting,
pending,
processing,
ready,
failed,
deleting
​
health
enum<string>
default:healthy
Available options:
healthy,
degraded
​
health_message
string | null
​
pending_event_id
string | null
​
pending_event_type
string | null
​
provisioned
boolean
default:false
​
reconcile_count
integer
default:0
​
version
integer
default:0
​
tags
string[] | null
​
provider_version
string | null