Skip to main content
GET
/
projects
/
{project_id}
/
patches
/
resources
/
{resource_id}
List Patches
curl --request GET \
  --url https://api.example.com/projects/{project_id}/patches/resources/{resource_id}
import requests

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

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

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 => "GET",
]);

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

curl_close($curl);

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

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/projects/{project_id}/patches/resources/{resource_id}")
  .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::Get.new(url)

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

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