Partial update of a policy
curl --request PATCH \
--url https://{tenant}.earnie.dev/v1/policies/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--data '
{
"name": "<string>",
"description": "<string>",
"agent_rule": "<string>",
"category": "<string>",
"enabled": true,
"values": {},
"expression": "<string>",
"parameter_spec": [
{
"key": "<string>",
"label": "<string>",
"options": [
"<string>"
],
"default": "<unknown>",
"constrains": "<string>"
}
]
}
'import requests
url = "https://{tenant}.earnie.dev/v1/policies/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"agent_rule": "<string>",
"category": "<string>",
"enabled": True,
"values": {},
"expression": "<string>",
"parameter_spec": [
{
"key": "<string>",
"label": "<string>",
"options": ["<string>"],
"default": "<unknown>",
"constrains": "<string>"
}
]
}
headers = {
"If-Match": "<if-match>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'If-Match': '<if-match>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
agent_rule: '<string>',
category: '<string>',
enabled: true,
values: {},
expression: '<string>',
parameter_spec: [
{
key: '<string>',
label: '<string>',
options: ['<string>'],
default: '<unknown>',
constrains: '<string>'
}
]
})
};
fetch('https://{tenant}.earnie.dev/v1/policies/{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://{tenant}.earnie.dev/v1/policies/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'agent_rule' => '<string>',
'category' => '<string>',
'enabled' => true,
'values' => [
],
'expression' => '<string>',
'parameter_spec' => [
[
'key' => '<string>',
'label' => '<string>',
'options' => [
'<string>'
],
'default' => '<unknown>',
'constrains' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"If-Match: <if-match>"
],
]);
$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://{tenant}.earnie.dev/v1/policies/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_rule\": \"<string>\",\n \"category\": \"<string>\",\n \"enabled\": true,\n \"values\": {},\n \"expression\": \"<string>\",\n \"parameter_spec\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"constrains\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("If-Match", "<if-match>")
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://{tenant}.earnie.dev/v1/policies/{id}")
.header("If-Match", "<if-match>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_rule\": \"<string>\",\n \"category\": \"<string>\",\n \"enabled\": true,\n \"values\": {},\n \"expression\": \"<string>\",\n \"parameter_spec\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"constrains\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.earnie.dev/v1/policies/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["If-Match"] = '<if-match>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_rule\": \"<string>\",\n \"category\": \"<string>\",\n \"enabled\": true,\n \"values\": {},\n \"expression\": \"<string>\",\n \"parameter_spec\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"constrains\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"policy": {
"id": 123,
"slug": "<string>",
"source": "seed",
"module": "<string>",
"category": "<string>",
"name": "<string>",
"description": "<string>",
"agent_rule": "<string>",
"agent_rule_stale": true,
"enabled": true,
"action": "block",
"expression": "<string>",
"parameter_spec": [
{
"key": "<string>",
"label": "<string>",
"type": "string",
"options": [
"<string>"
],
"default": "<unknown>",
"constrains": "<string>"
}
],
"values": {},
"revision": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"result_summary": {
"state": "passed",
"violations_count": 1,
"affected_files_count": 1,
"affected_components_count": 1,
"missing_enrichments": [
"<string>"
],
"error_message": "<string>",
"last_evaluated_at": "2023-11-07T05:31:56Z"
}
},
"change_kind": "tweak"
}{
"code": "cel_compile",
"message": "<string>",
"position": 123
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "unguarded_field",
"message": "<string>",
"path": "<string>",
"optional": true,
"position": 123
}{
"code": "<string>",
"message": "<string>"
}API Reference
Partial update of a policy
Server classifies the request by payload:
- Only
values/enabled/name/action→ tweak (no recompile; auditpolicy.values_updated). expressionorparameter_specpresent → authoring (recompile + revalidate; auditpolicy.expression_updated). Thechange_kindfield on the response carries the classification.
The update is conditional on the policy’s revision: the caller passes the revision it last read as If-Match, and a concurrent editor who moved the policy on gets 409 policy_conflict instead of silently losing their edit.
PATCH
/
v1
/
policies
/
{id}
Partial update of a policy
curl --request PATCH \
--url https://{tenant}.earnie.dev/v1/policies/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--data '
{
"name": "<string>",
"description": "<string>",
"agent_rule": "<string>",
"category": "<string>",
"enabled": true,
"values": {},
"expression": "<string>",
"parameter_spec": [
{
"key": "<string>",
"label": "<string>",
"options": [
"<string>"
],
"default": "<unknown>",
"constrains": "<string>"
}
]
}
'import requests
url = "https://{tenant}.earnie.dev/v1/policies/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"agent_rule": "<string>",
"category": "<string>",
"enabled": True,
"values": {},
"expression": "<string>",
"parameter_spec": [
{
"key": "<string>",
"label": "<string>",
"options": ["<string>"],
"default": "<unknown>",
"constrains": "<string>"
}
]
}
headers = {
"If-Match": "<if-match>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'If-Match': '<if-match>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
agent_rule: '<string>',
category: '<string>',
enabled: true,
values: {},
expression: '<string>',
parameter_spec: [
{
key: '<string>',
label: '<string>',
options: ['<string>'],
default: '<unknown>',
constrains: '<string>'
}
]
})
};
fetch('https://{tenant}.earnie.dev/v1/policies/{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://{tenant}.earnie.dev/v1/policies/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'agent_rule' => '<string>',
'category' => '<string>',
'enabled' => true,
'values' => [
],
'expression' => '<string>',
'parameter_spec' => [
[
'key' => '<string>',
'label' => '<string>',
'options' => [
'<string>'
],
'default' => '<unknown>',
'constrains' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"If-Match: <if-match>"
],
]);
$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://{tenant}.earnie.dev/v1/policies/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_rule\": \"<string>\",\n \"category\": \"<string>\",\n \"enabled\": true,\n \"values\": {},\n \"expression\": \"<string>\",\n \"parameter_spec\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"constrains\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("If-Match", "<if-match>")
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://{tenant}.earnie.dev/v1/policies/{id}")
.header("If-Match", "<if-match>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_rule\": \"<string>\",\n \"category\": \"<string>\",\n \"enabled\": true,\n \"values\": {},\n \"expression\": \"<string>\",\n \"parameter_spec\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"constrains\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.earnie.dev/v1/policies/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["If-Match"] = '<if-match>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_rule\": \"<string>\",\n \"category\": \"<string>\",\n \"enabled\": true,\n \"values\": {},\n \"expression\": \"<string>\",\n \"parameter_spec\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"options\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"constrains\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"policy": {
"id": 123,
"slug": "<string>",
"source": "seed",
"module": "<string>",
"category": "<string>",
"name": "<string>",
"description": "<string>",
"agent_rule": "<string>",
"agent_rule_stale": true,
"enabled": true,
"action": "block",
"expression": "<string>",
"parameter_spec": [
{
"key": "<string>",
"label": "<string>",
"type": "string",
"options": [
"<string>"
],
"default": "<unknown>",
"constrains": "<string>"
}
],
"values": {},
"revision": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"result_summary": {
"state": "passed",
"violations_count": 1,
"affected_files_count": 1,
"affected_components_count": 1,
"missing_enrichments": [
"<string>"
],
"error_message": "<string>",
"last_evaluated_at": "2023-11-07T05:31:56Z"
}
},
"change_kind": "tweak"
}{
"code": "cel_compile",
"message": "<string>",
"position": 123
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "unguarded_field",
"message": "<string>",
"path": "<string>",
"optional": true,
"position": 123
}{
"code": "<string>",
"message": "<string>"
}Authorizations
An Earnie API key, sent as Authorization: Bearer sk_earnie_.... Create one under Settings > API keys. The key's scopes decide which operations it may call.
Headers
The policy revision the caller last read. Required: a policy mutation is never last-write-wins. Omitted → 428 precondition_required; no longer current → 409 policy_conflict.
The bare digest, its quoted form and its weak form all mean the same revision. * is refused with 409 rather than honoured as "any current representation", which would be exactly the unconditional write this exists to prevent. A comma-separated list of entity tags is refused with 400: a policy has one current revision, so offering several is not meaningful here, and saying so beats answering 409 for a request that was not understood.
Path Parameters
Body
application/json
PATCH semantics. Presence of any of expression / parameter_spec classifies the request as authoring (recompile + revalidate, audit policy.expression_updated). Otherwise the request is a tweak (no recompile, audit policy.values_updated). Omitted fields are left unchanged.
The imperative sentence an AI coding agent reads instead of the CEL (see Policy.agent_rule). A tweak, never authoring: it changes no gating content, so it neither recompiles the expression nor moves the policy revision.
Grouping within a scanner (e.g. licenses, vulnerabilities). Mutable — users can re-categorize a policy from the editor. Treated as a tweak (no recompile, no audit beyond the standard policy.values_updated).
Enforcement action applied when the policy fires. Verdict mapping: block → block warn → warn require → require
Available options:
block, warn, require Show child attributes
Show child attributes