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

url = "https://api.example.com/projects/{project_id}/patches/resources/{resource_id}"

payload = {
    "definition": {
        "patch_id": "<string>",
        "description": "",
        "constraints": [],
        "payload": {},
        "metadata": {}
    },
    "constraints": []
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    definition: {
      patch_id: '<string>',
      description: '',
      constraints: [],
      payload: {},
      metadata: {}
    },
    constraints: []
  })
};

fetch('https://api.example.com/projects/{project_id}/patches/resources/{resource_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/projects/{project_id}/patches/resources/{resource_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'definition' => [
        'patch_id' => '<string>',
        'description' => '',
        'constraints' => [
                
        ],
        'payload' => [
                
        ],
        'metadata' => [
                
        ]
    ],
    'constraints' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/projects/{project_id}/patches/resources/{resource_id}"

	payload := strings.NewReader("{\n  \"definition\": {\n    \"patch_id\": \"<string>\",\n    \"description\": \"\",\n    \"constraints\": [],\n    \"payload\": {},\n    \"metadata\": {}\n  },\n  \"constraints\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/projects/{project_id}/patches/resources/{resource_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"definition\": {\n    \"patch_id\": \"<string>\",\n    \"description\": \"\",\n    \"constraints\": [],\n    \"payload\": {},\n    \"metadata\": {}\n  },\n  \"constraints\": []\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/projects/{project_id}/patches/resources/{resource_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"definition\": {\n    \"patch_id\": \"<string>\",\n    \"description\": \"\",\n    \"constraints\": [],\n    \"payload\": {},\n    \"metadata\": {}\n  },\n  \"constraints\": []\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

​
resource_id
string
required
​
project_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