Skip to main content
POST
/
resources
/
{resource_id}
/
patches
Create Patch
curl --request POST \
  --url https://api.example.com/resources/{resource_id}/patches \
  --header 'Content-Type: application/json' \
  --data '
{
  "definition": {
    "patch_id": "<string>",
    "description": "",
    "constraints": [],
    "payload": {},
    "metadata": {}
  },
  "constraints": []
}
'
{
  "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

Body

application/json

Request body for creating a new patch.

Attributes: definition: Patch content describing the action and parameters. constraints: Compatibility constraints for target resource eligibility.

​
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.).

​
constraints
CompatibilityConstraint · object[]

Response

Successful Response

A patch record stored in SurrealDB.

Patches are migration scripts, schema diffs, or configuration changes recorded against a source resource. They can be applied to any compatible resource that satisfies the declared constraints.

Attributes: patch_id: Unique identifier for this patch. resource_id: SurrealDB ID of the source resource this patch was created against. definition: Patch content (action, parameters, description). constraints: Compatibility constraints for target resource eligibility. status: Current lifecycle status (pending, applied, failed). created_by: User or agent ID that created the patch. created_at: When the patch was created. error: Error message if patch application failed.

​
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