Skip to main content
PATCH
/
org
/
{org}
/
group
/
{name}
Patch
curl --request PATCH \
  --url https://api.cpln.io/org/{org}/group/{name} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "tags": {},
  "memberLinks": [
    "<string>"
  ],
  "memberQuery": {
    "spec": {
      "match": "all",
      "terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  },
  "origin": "default"
}
'
{
  "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": "<unknown>"
        }
      ]
    }
  },
  "origin": "default"
}

Authorizations

Authorization
string
header
required

Service account key can be used as API keys

Path Parameters

org
string
required
name
string
required

Body

application/json
name
string
Maximum string length: 64
description
string
tags
object
memberQuery
object
origin
enum<string>
default:default
Available options:
synthetic,
default,
builtin

Response

Success

id
string
name
string
Maximum string length: 64
kind
string
version
integer
description
string
tags
object
created
string<date-time>
lastModified
string<date-time>
memberQuery
object
origin
enum<string>
default:default
Available options:
synthetic,
default,
builtin