Skip to main content
GET
/
resources
/
{resource_id}
/
patches
List Patches
curl --request GET \
  --url https://api.example.com/resources/{resource_id}/patches
[
  {
    "patch_id": "<string>",
    "resource_id": "<string>",
    "definition": {
      "patch_id": "<string>",
      "description": "",
      "constraints": [],
      "payload": {},
      "metadata": {}
    },
    "created_by": "<string>",
    "constraints": [],
    "status": "pending",
    "created_at": "2023-11-07T05:31:56Z",
    "error": "<string>"
  }
]

Path Parameters

​
resource_id
string
required

Response

Successful Response

​
patch_id
string
required
​
resource_id
string
required
​
definition
PatchDefinition · object
required

Definition of a patch to apply to a resource.

Patches are migration scripts, schema diffs, or configuration changes that can be applied to a resource. They include compatibility constraints to ensure they are only applied to eligible resources.

Attributes: patch_id: Unique identifier for this patch. description: Human-readable description of what this patch does. constraints: Compatibility constraints the resource must satisfy. payload: Patch-specific data (e.g., migration script, schema diff). metadata: Additional context about the patch (author, source, etc.).

​
created_by
string
required
​
constraints
CompatibilityConstraint · object[]
​
status
enum<string>
default:pending

Lifecycle status of a patch record.

Attributes: PENDING: Patch recorded but not yet applied. DISPATCHED: Patch event sent to provider, awaiting confirmation. APPLIED: Patch confirmed applied by the provider. FAILED: Patch application failed.

Available options:
pending,
dispatched,
applied,
failed
​
created_at
string<date-time>
​
error
string | null