Skip to main content
GET
/
org
/
{org}
/
policy
/
{name}
Get a policy by name
curl --request GET \
  --url https://api.cpln.io/org/{org}/policy/{name} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "kind": "<string>",
  "version": 123,
  "description": "<string>",
  "tags": {},
  "created": "2023-11-07T05:31:56Z",
  "lastModified": "2023-11-07T05:31:56Z",
  "links": [
    {
      "rel": "<string>",
      "href": "<string>"
    }
  ],
  "targetKind": "org",
  "targetLinks": [
    "<string>"
  ],
  "targetQuery": {
    "kind": "<string>",
    "context": {},
    "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>"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Service account key can be used as API keys

Path Parameters

org
string
required
name
string
required

Response

Success

id
string
name
string
Maximum string length: 64
kind
string
version
integer
description
string
Maximum string length: 250
tags
object
created
string<date-time>
lastModified
string<date-time>
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[]