group
Perform a Patch on a group by name
Overview
agent
auditctx
cloudaccount
- GETGet a cloud account by name
- DELDelete an cloud account by name
- PATCHPerform a Patch on a cloud account by name
- GETGet all cloud accounts
- POSTCreate a cloud account
- POSTGet all cloud accounts based on a query
- GETGet the access report for a cloud account by name
- GETGet available permissions for a cloud account resource type
domain
group
gvc
identity
- GETGet an identity by GVC and name
- DELDelete an identity by GVC and name
- PATCHPerform a Patch on an identity by name
- GETGet all identities in a GVC
- POSTCreate an identity
- GETGet all identities from all GVCs
- POSTGet all GVC identities based on a query
- GETGet the access report for an identity by GVC and name
- GETGet available permissions for an identity
image
location
org
policy
quota
secret
- GETGet a secret by name
- DELDelete a secret by name
- PATCHPerform a Patch on an IP Set by name
- GETGet all secrets
- POSTCreate a secret
- GETGet the sensitive content of a secret by name
- POSTGet all secrets based on a query
- GETGet the access report for a secret by name
- GETGet available permissions for a secret resource type
serviceaccount
- GETGet a service account by name
- DELDelete a service account by name
- PATCHPerform a Patch on a service account by name
- GETGet all service accounts
- POSTCreate a service account
- POSTGet all service accounts based on a query
- GETGet the access report for a service account by name
- POSTAdd a key to a service account
- GETGet available permissions for a service account resource type
task
user
volumeset
- GETGet a volumeset by GVC and name
- DELDelete a volumeset by name
- PATCHPerform a Patch on a volumeset by name
- GETList volumesets in a GVC you are authorized to view
- POSTCreate a volumeset
- GETGet all volumesets
- POSTGet all volumesets based on a query
- GETGet the access report for a volumeset by GVC and name
- GETGet available permissions for a volumeset resource type
workload
- GETGet a workload by GVC and name
- DELDelete a workload by name
- PATCHPerform a Patch on a workload by name
- GETGet a deployment by GVC, workload and name
- GETList workloads in a GVC you are authorized to view
- POSTCreate a workload
- GETGet all workloads
- GETList deployments in a workload
- POSTGet all workloads based on a query
- GETGet the access report for a workload by GVC and name
- GETGet available permissions for a workload resource type
group
Perform a Patch on a group by name
PATCH
/
org
/
{org}
/
group
/
{name}
curl --request PATCH \
--url https://api.cpln.io/org/{org}/group/{name} \
--header 'Content-Type: application/json' \
--data '{
"$drop": [
"description"
],
"description": "<string>",
"tags": {},
"$replace/tags": {},
"memberLinks": [
"<string>"
],
"$drop/memberLinks": [
"<string>"
],
"$append/memberLinks": [
"<string>"
],
"$retain/memberLinks": [
"<string>"
],
"memberQuery": {
"$drop": [
"kind"
],
"kind": "<string>",
"spec": {
"$drop": [
"match"
],
"match": "all",
"terms": [
{
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"value": "<string>"
}
],
"$drop/terms": [
"<string>"
],
"$append/terms": [
{
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"value": "<string>"
}
],
"$patch/terms": [
{
"$drop": [
"op"
],
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"$replace/value": "<string>",
"value": "<any>"
}
],
"$retain/terms": [
"<string>"
],
"sort": {
"$drop": [
"by"
],
"by": "<string>",
"order": "asc"
},
"$replace/sort": {
"by": "<string>",
"order": "asc"
}
},
"$replace/spec": {
"match": "all",
"terms": [
{
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"value": "<string>"
}
],
"sort": {
"by": "<string>",
"order": "asc"
}
}
},
"$replace/memberQuery": {
"kind": "<string>",
"spec": {
"match": "all",
"terms": [
{
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"value": "<string>"
}
],
"sort": {
"by": "<string>",
"order": "asc"
}
}
},
"identityMatcher": {
"$drop": [
"expression"
],
"expression": "<string>",
"language": "jmespath"
},
"$replace/identityMatcher": {
"expression": "<string>",
"language": "jmespath"
}
}'{
"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>"
}
],
"memberLinks": [
"<string>"
],
"memberQuery": {
"kind": "<string>",
"context": {},
"spec": {
"match": "all",
"terms": [
{
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"value": "<string>"
}
],
"sort": {
"by": "<string>",
"order": "asc"
}
}
},
"identityMatcher": {
"expression": "<string>",
"language": "jmespath"
},
"origin": "default"
}Authorizations
Service account key can be used as API keys
Body
application/json
Available options:
description, tags, memberLinks, memberQuery, identityMatcher Maximum length:
250Available options:
kind, spec Available options:
match, terms, sort Available options:
all, any, none Available options:
op, property, rel, tag, value Available options:
=, >, >=, <, <=, !=, ~, exists, !exists Available options:
all, any, none Available options:
all, any, none Response
200
application/json
Success
Maximum length:
64Maximum length:
250Available options:
all, any, none Available options:
synthetic, default, builtin curl --request PATCH \
--url https://api.cpln.io/org/{org}/group/{name} \
--header 'Content-Type: application/json' \
--data '{
"$drop": [
"description"
],
"description": "<string>",
"tags": {},
"$replace/tags": {},
"memberLinks": [
"<string>"
],
"$drop/memberLinks": [
"<string>"
],
"$append/memberLinks": [
"<string>"
],
"$retain/memberLinks": [
"<string>"
],
"memberQuery": {
"$drop": [
"kind"
],
"kind": "<string>",
"spec": {
"$drop": [
"match"
],
"match": "all",
"terms": [
{
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"value": "<string>"
}
],
"$drop/terms": [
"<string>"
],
"$append/terms": [
{
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"value": "<string>"
}
],
"$patch/terms": [
{
"$drop": [
"op"
],
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"$replace/value": "<string>",
"value": "<any>"
}
],
"$retain/terms": [
"<string>"
],
"sort": {
"$drop": [
"by"
],
"by": "<string>",
"order": "asc"
},
"$replace/sort": {
"by": "<string>",
"order": "asc"
}
},
"$replace/spec": {
"match": "all",
"terms": [
{
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"value": "<string>"
}
],
"sort": {
"by": "<string>",
"order": "asc"
}
}
},
"$replace/memberQuery": {
"kind": "<string>",
"spec": {
"match": "all",
"terms": [
{
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"value": "<string>"
}
],
"sort": {
"by": "<string>",
"order": "asc"
}
}
},
"identityMatcher": {
"$drop": [
"expression"
],
"expression": "<string>",
"language": "jmespath"
},
"$replace/identityMatcher": {
"expression": "<string>",
"language": "jmespath"
}
}'{
"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>"
}
],
"memberLinks": [
"<string>"
],
"memberQuery": {
"kind": "<string>",
"context": {},
"spec": {
"match": "all",
"terms": [
{
"op": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"value": "<string>"
}
],
"sort": {
"by": "<string>",
"order": "asc"
}
}
},
"identityMatcher": {
"expression": "<string>",
"language": "jmespath"
},
"origin": "default"
}