Create an ActionPolicy
curl --request POST \
--url https://api.checkfu.com/v1/action-policies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"name": "<string>",
"rules": [
{
"id": "<string>",
"subject_kind": "*",
"subject_id": "<string>",
"resource_kind": "*",
"resource_id": "<string>",
"permission": "<string>",
"surface_scope_id": "<string>",
"argument_conditions": [
{
"path": [
"<string>"
],
"predicate": {
"op": "exact",
"to": {
"source": "literal",
"value": "<string>"
}
}
}
]
}
]
}
'import requests
url = "https://api.checkfu.com/v1/action-policies"
payload = {
"name": "<string>",
"rules": [
{
"id": "<string>",
"subject_kind": "*",
"subject_id": "<string>",
"resource_kind": "*",
"resource_id": "<string>",
"permission": "<string>",
"surface_scope_id": "<string>",
"argument_conditions": [
{
"path": ["<string>"],
"predicate": {
"op": "exact",
"to": {
"source": "literal",
"value": "<string>"
}
}
}
]
}
]
}
headers = {
"checkfu-version": "<checkfu-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'checkfu-version': '<checkfu-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
rules: [
{
id: '<string>',
subject_kind: '*',
subject_id: '<string>',
resource_kind: '*',
resource_id: '<string>',
permission: '<string>',
surface_scope_id: '<string>',
argument_conditions: [
{
path: ['<string>'],
predicate: {op: 'exact', to: {source: 'literal', value: '<string>'}}
}
]
}
]
})
};
fetch('https://api.checkfu.com/v1/action-policies', 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.checkfu.com/v1/action-policies",
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([
'name' => '<string>',
'rules' => [
[
'id' => '<string>',
'subject_kind' => '*',
'subject_id' => '<string>',
'resource_kind' => '*',
'resource_id' => '<string>',
'permission' => '<string>',
'surface_scope_id' => '<string>',
'argument_conditions' => [
[
'path' => [
'<string>'
],
'predicate' => [
'op' => 'exact',
'to' => [
'source' => 'literal',
'value' => '<string>'
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-version: <checkfu-version>"
],
]);
$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.checkfu.com/v1/action-policies"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"<string>\",\n \"subject_kind\": \"*\",\n \"subject_id\": \"<string>\",\n \"resource_kind\": \"*\",\n \"resource_id\": \"<string>\",\n \"permission\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"argument_conditions\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"predicate\": {\n \"op\": \"exact\",\n \"to\": {\n \"source\": \"literal\",\n \"value\": \"<string>\"\n }\n }\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
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.post("https://api.checkfu.com/v1/action-policies")
.header("checkfu-version", "<checkfu-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"<string>\",\n \"subject_kind\": \"*\",\n \"subject_id\": \"<string>\",\n \"resource_kind\": \"*\",\n \"resource_id\": \"<string>\",\n \"permission\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"argument_conditions\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"predicate\": {\n \"op\": \"exact\",\n \"to\": {\n \"source\": \"literal\",\n \"value\": \"<string>\"\n }\n }\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/action-policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"<string>\",\n \"subject_kind\": \"*\",\n \"subject_id\": \"<string>\",\n \"resource_kind\": \"*\",\n \"resource_id\": \"<string>\",\n \"permission\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"argument_conditions\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"predicate\": {\n \"op\": \"exact\",\n \"to\": {\n \"source\": \"literal\",\n \"value\": \"<string>\"\n }\n }\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"state": "active",
"rules": [
{
"id": "<string>",
"effect": "allow",
"subject_kind": "*",
"subject_id": "<string>",
"resource_kind": "*",
"resource_id": "<string>",
"permission": "<string>",
"surface_scope_id": "<string>",
"surface_scope_kind": "root",
"argument_conditions": [
{
"path": [
"<string>"
],
"predicate": {
"op": "exact",
"to": {
"source": "literal",
"value": "<string>"
}
}
}
]
}
],
"version": 1,
"created_at": "<string>",
"updated_at": "<string>"
}{
"error": {
"type": "validation.malformed",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-malformed"
}
}{
"error": {
"type": "auth.invalid_key",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
}
}{
"error": {
"type": "auth.disabled_tenancy",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
}
}{
"error": {
"type": "validation.not_found",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-not-found"
}
}{
"error": {
"type": "validation.conflict",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-conflict"
}
}{
"error": {
"type": "budget.exceeded",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
}
}{
"error": {
"type": "runtime.internal",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#runtime-internal"
}
}Create an ActionPolicy
Create one ActionPolicy carrying 1 to 256 rules, each naming a subject kind and id, resource kind and id, permission, and optional surface scope, with an effect of allow, require_approval, or deny. Every pattern is a glob in which * and ? are the only operators, and rule ids must be unique inside the ActionPolicy. ActionPolicies are immutable, so replace rather than edit one. Accepts an Idempotency-Key.
Checkfu support posture: alpha; hosted. Required evidence journey: governance-registry. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.
POST
/
v1
/
action-policies
Create an ActionPolicy
curl --request POST \
--url https://api.checkfu.com/v1/action-policies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'checkfu-version: <checkfu-version>' \
--data '
{
"name": "<string>",
"rules": [
{
"id": "<string>",
"subject_kind": "*",
"subject_id": "<string>",
"resource_kind": "*",
"resource_id": "<string>",
"permission": "<string>",
"surface_scope_id": "<string>",
"argument_conditions": [
{
"path": [
"<string>"
],
"predicate": {
"op": "exact",
"to": {
"source": "literal",
"value": "<string>"
}
}
}
]
}
]
}
'import requests
url = "https://api.checkfu.com/v1/action-policies"
payload = {
"name": "<string>",
"rules": [
{
"id": "<string>",
"subject_kind": "*",
"subject_id": "<string>",
"resource_kind": "*",
"resource_id": "<string>",
"permission": "<string>",
"surface_scope_id": "<string>",
"argument_conditions": [
{
"path": ["<string>"],
"predicate": {
"op": "exact",
"to": {
"source": "literal",
"value": "<string>"
}
}
}
]
}
]
}
headers = {
"checkfu-version": "<checkfu-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'checkfu-version': '<checkfu-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
rules: [
{
id: '<string>',
subject_kind: '*',
subject_id: '<string>',
resource_kind: '*',
resource_id: '<string>',
permission: '<string>',
surface_scope_id: '<string>',
argument_conditions: [
{
path: ['<string>'],
predicate: {op: 'exact', to: {source: 'literal', value: '<string>'}}
}
]
}
]
})
};
fetch('https://api.checkfu.com/v1/action-policies', 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.checkfu.com/v1/action-policies",
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([
'name' => '<string>',
'rules' => [
[
'id' => '<string>',
'subject_kind' => '*',
'subject_id' => '<string>',
'resource_kind' => '*',
'resource_id' => '<string>',
'permission' => '<string>',
'surface_scope_id' => '<string>',
'argument_conditions' => [
[
'path' => [
'<string>'
],
'predicate' => [
'op' => 'exact',
'to' => [
'source' => 'literal',
'value' => '<string>'
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"checkfu-version: <checkfu-version>"
],
]);
$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.checkfu.com/v1/action-policies"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"<string>\",\n \"subject_kind\": \"*\",\n \"subject_id\": \"<string>\",\n \"resource_kind\": \"*\",\n \"resource_id\": \"<string>\",\n \"permission\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"argument_conditions\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"predicate\": {\n \"op\": \"exact\",\n \"to\": {\n \"source\": \"literal\",\n \"value\": \"<string>\"\n }\n }\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("checkfu-version", "<checkfu-version>")
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.post("https://api.checkfu.com/v1/action-policies")
.header("checkfu-version", "<checkfu-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"<string>\",\n \"subject_kind\": \"*\",\n \"subject_id\": \"<string>\",\n \"resource_kind\": \"*\",\n \"resource_id\": \"<string>\",\n \"permission\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"argument_conditions\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"predicate\": {\n \"op\": \"exact\",\n \"to\": {\n \"source\": \"literal\",\n \"value\": \"<string>\"\n }\n }\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.checkfu.com/v1/action-policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"<string>\",\n \"subject_kind\": \"*\",\n \"subject_id\": \"<string>\",\n \"resource_kind\": \"*\",\n \"resource_id\": \"<string>\",\n \"permission\": \"<string>\",\n \"surface_scope_id\": \"<string>\",\n \"argument_conditions\": [\n {\n \"path\": [\n \"<string>\"\n ],\n \"predicate\": {\n \"op\": \"exact\",\n \"to\": {\n \"source\": \"literal\",\n \"value\": \"<string>\"\n }\n }\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"state": "active",
"rules": [
{
"id": "<string>",
"effect": "allow",
"subject_kind": "*",
"subject_id": "<string>",
"resource_kind": "*",
"resource_id": "<string>",
"permission": "<string>",
"surface_scope_id": "<string>",
"surface_scope_kind": "root",
"argument_conditions": [
{
"path": [
"<string>"
],
"predicate": {
"op": "exact",
"to": {
"source": "literal",
"value": "<string>"
}
}
}
]
}
],
"version": 1,
"created_at": "<string>",
"updated_at": "<string>"
}{
"error": {
"type": "validation.malformed",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-malformed"
}
}{
"error": {
"type": "auth.invalid_key",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
}
}{
"error": {
"type": "auth.disabled_tenancy",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
}
}{
"error": {
"type": "validation.not_found",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-not-found"
}
}{
"error": {
"type": "validation.conflict",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#validation-conflict"
}
}{
"error": {
"type": "budget.exceeded",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
}
}{
"error": {
"type": "runtime.internal",
"message": "<string>",
"more": "https://docs.checkfu.com/reference/errors#runtime-internal"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Available options:
2026-08-24 Maximum string length:
255Body
application/json
Response
Success
Pattern:
^apol_[0-9a-f]{32}$Pattern:
^wrkspc_[0-9a-f]{32}$Required string length:
1 - 255Available options:
active, disabled Required array length:
1 - 256 elementsShow child attributes
Show child attributes
Required range:
x > 0