Skip to main content
POST
/
org
/
{org}
/
policy
Create a policy
curl --request POST \
  --url https://api.cpln.io/org/{org}/policy \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "tags": {},
  "targetKind": "org",
  "targetLinks": [
    "<string>"
  ],
  "targetQuery": {
    "kind": "<string>",
    "spec": {
      "match": "all",
      "terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<string>"
        }
      ],
      "sort": {
        "by": "<string>",
        "order": "asc"
      }
    }
  },
  "target": "all",
  "origin": "default",
  "bindings": [
    {
      "permissions": [
        "<string>"
      ],
      "principalLinks": [
        "<string>"
      ]
    }
  ]
}
'
{
  "status": 123,
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Service account key can be used as API keys

Path Parameters

org
string
required

Body

application/json
name
string
Maximum string length: 64
description
string
Maximum string length: 250
tags
object
targetKind
enum<string>
Available options:
org,
cloudaccount,
policy,
user,
group,
resource,
task,
permissions,
serviceaccount,
secret,
location,
gvc,
workload,
quota,
identity,
deployment,
event,
domain,
image,
ipset,
resourcepolicy,
agent,
accessreport,
policymembership,
dbcluster,
auditctx,
memcachecluster,
spicedbcluster,
tenant,
mk8s,
command,
imagesummary,
volumeset
targetQuery
object
target
enum<string>
Available options:
all
origin
enum<string>
default:default
Available options:
default,
builtin
bindings
object[]

Response

Policy was created successfully