curl --request GET \
--url https://{tenant}.earnie.dev/v1/policies/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{tenant}.earnie.dev/v1/policies/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{tenant}.earnie.dev/v1/policies/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{tenant}.earnie.dev/v1/policies/{id}")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Read one policy
The authoritative answer to “does this policy exist, and is it here?”.
A client that proves a policy’s absence from a cached collection cannot tell a genuinely missing policy from a list that is merely stale or failed to load, and renders all three as a 404. This read separates them: 404 means the policy does not exist (or, with project_id, is not attached to that project), and any other failure is reported as what it is.
With project_id the response carries the project-scoped result_summary, exactly as the project’s policy list does, so a detail view needs no second shape.
curl --request GET \
--url https://{tenant}.earnie.dev/v1/policies/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{tenant}.earnie.dev/v1/policies/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{tenant}.earnie.dev/v1/policies/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{tenant}.earnie.dev/v1/policies/{id}")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"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.
Path Parameters
Query Parameters
Read the policy through this project's attachment. The project must belong to the caller's organization; a policy that exists but is not attached to it answers 404, because it is not this project's policy to show.
Response
The policy
Stable, human-readable identifier safe across deploys and migrations. Generated from name (kebab-cased) on Create when not supplied; templates ship with deterministic slugs (e.g. block-copyleft-licenses). Immutable after creation.
Server-managed origin of the policy. Seeded templates return seed; user-authored rows return custom.
seed, custom Finding domain the policy targets (e.g. scans, crypto, crypto_finder). AI provenance is an xBOM enrichment, not a separate policy domain.
Grouping within a scanner (e.g. licenses, vulnerabilities).
Human-readable explanation of what the policy checks and why.
Keep it to roughly 200 bytes. That is not a stored-length limit — nothing rejects a longer one — it is where the RENDERED sentence is truncated with an ellipsis before it reaches an agent, measured after placeholders are substituted and in bytes rather than characters. A short rule whose {banned_licenses} expands to three hundred bytes is truncated too. The cap exists because this text sits in every prompt of every session.
Written in the second person, one sentence, no CEL: "Do not add dependencies licensed {banned_licenses}."
{key} placeholders name parameter_spec[].key entries and are substituted with the policy's current values at render time, so one sentence stays true after a parameter is tuned. A list value renders as a, b or c. A placeholder naming no parameter is rejected on save.
Empty is allowed and means "no agent rule": rendering falls back to description, and last to the CEL expression labelled as such, so a policy without one still reaches an agent. Like description it is prose and NOT part of the policy revision — rewording what an agent reads does not change what the gate does.
True when agent_rule was written against different rule logic than this policy now carries — its action, expression, or the set of parameter keys has changed since the sentence was last saved.
An agent rule is hand-written prose and cannot be derived from CEL, so nothing keeps it true when the expression moves underneath it. This is how the product notices: the sentence still renders (it is usually still mostly right), but the policy is flagged so a human can review it. Saving the agent rule again clears the flag.
Parameter VALUES are deliberately excluded: {key} placeholders already keep the sentence true across a retune, so a threshold tweak never raises this. False when the policy has no agent rule, and false for a row that predates the stored basis — "unknown" must not read as "stale".
Enforcement action applied when the policy fires. Verdict mapping: block → block warn → warn require → require
block, warn, require CEL string. Compiled via cel-go on save (parse + type check + params.X consistency) and evaluated against findings via Eval (see /preview for the live-evaluation surface).
Show child attributes
Show child attributes
Current parameter values keyed by parameter_spec[].key. Every declared key needs a value or a default in its spec entry, including a parameter the expression only reads behind has(); a key left out is stored with its default. See ValuesInvalidError.
The policy's immutable content revision: a sha256: digest over the canonical form of the gating content — action, expression, parameter_spec, values. It is byte-identical to the policy_hash an evaluation records and to the revision a scan's policy snapshot names, so "which revision produced this verdict" and "which revision is live now" are answered in one vocabulary.
Mutations echo it back in If-Match. A stale revision is 409 policy_conflict; a policy edit is never last-write-wins.
It covers the gating content and nothing else. Renaming a policy or rewriting its description leaves the revision unchanged, because neither changes what the gate does, and enabled is carried by presence in a scan's snapshot rather than by the digest.
Show child attributes
Show child attributes