Perform a Patch on a group by name
curl --request PATCH \
--url https://api.cpln.io/org/{org}/group/{name} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"$drop": [],
"name": "<string>",
"description": "<string>",
"tags": {},
"$replace/tags": {},
"memberLinks": [
"<string>"
],
"$drop/memberLinks": [
"<string>"
],
"$append/memberLinks": [
"<string>"
],
"$retain/memberLinks": [
"<string>"
],
"memberQuery": {
"$drop": [],
"kind": "<string>",
"spec": {
"$drop": [],
"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": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"$replace/value": "<string>",
"value": "<unknown>"
}
],
"$retain/terms": [
"<string>"
],
"sort": {
"$drop": [],
"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": "<string>",
"language": "jmespath"
},
"$replace/identityMatcher": {
"expression": "<string>",
"language": "jmespath"
}
}
'import requests
url = "https://api.cpln.io/org/{org}/group/{name}"
payload = {
"$drop": [],
"name": "<string>",
"description": "<string>",
"tags": {},
"$replace/tags": {},
"memberLinks": ["<string>"],
"$drop/memberLinks": ["<string>"],
"$append/memberLinks": ["<string>"],
"$retain/memberLinks": ["<string>"],
"memberQuery": {
"$drop": [],
"kind": "<string>",
"spec": {
"$drop": [],
"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": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"$replace/value": "<string>",
"value": "<unknown>"
}
],
"$retain/terms": ["<string>"],
"sort": {
"$drop": [],
"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": "<string>",
"language": "jmespath"
},
"$replace/identityMatcher": {
"expression": "<string>",
"language": "jmespath"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
$drop: [],
name: '<string>',
description: '<string>',
tags: {},
'$replace/tags': {},
memberLinks: ['<string>'],
'$drop/memberLinks': ['<string>'],
'$append/memberLinks': ['<string>'],
'$retain/memberLinks': ['<string>'],
memberQuery: {
$drop: [],
kind: '<string>',
spec: {
$drop: [],
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: '=',
property: '<string>',
rel: '<string>',
tag: '<string>',
'$replace/value': '<string>',
value: '<unknown>'
}
],
'$retain/terms': ['<string>'],
sort: {$drop: [], 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: '<string>', language: 'jmespath'},
'$replace/identityMatcher': {expression: '<string>', language: 'jmespath'}
})
};
fetch('https://api.cpln.io/org/{org}/group/{name}', 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.cpln.io/org/{org}/group/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'$drop' => [
],
'name' => '<string>',
'description' => '<string>',
'tags' => [
],
'$replace/tags' => [
],
'memberLinks' => [
'<string>'
],
'$drop/memberLinks' => [
'<string>'
],
'$append/memberLinks' => [
'<string>'
],
'$retain/memberLinks' => [
'<string>'
],
'memberQuery' => [
'$drop' => [
],
'kind' => '<string>',
'spec' => [
'$drop' => [
],
'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' => '=',
'property' => '<string>',
'rel' => '<string>',
'tag' => '<string>',
'$replace/value' => '<string>',
'value' => '<unknown>'
]
],
'$retain/terms' => [
'<string>'
],
'sort' => [
'$drop' => [
],
'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' => '<string>',
'language' => 'jmespath'
],
'$replace/identityMatcher' => [
'expression' => '<string>',
'language' => 'jmespath'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.cpln.io/org/{org}/group/{name}"
payload := strings.NewReader("{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"memberLinks\": [\n \"<string>\"\n ],\n \"$drop/memberLinks\": [\n \"<string>\"\n ],\n \"$append/memberLinks\": [\n \"<string>\"\n ],\n \"$retain/memberLinks\": [\n \"<string>\"\n ],\n \"memberQuery\": {\n \"$drop\": [],\n \"kind\": \"<string>\",\n \"spec\": {\n \"$drop\": [],\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$drop/terms\": [\n \"<string>\"\n ],\n \"$append/terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$patch/terms\": [\n {\n \"$drop\": [],\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"$replace/value\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"$retain/terms\": [\n \"<string>\"\n ],\n \"sort\": {\n \"$drop\": [],\n \"by\": \"<string>\",\n \"order\": \"asc\"\n },\n \"$replace/sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n },\n \"$replace/spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"$replace/memberQuery\": {\n \"kind\": \"<string>\",\n \"spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"identityMatcher\": {\n \"$drop\": [],\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n },\n \"$replace/identityMatcher\": {\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.patch("https://api.cpln.io/org/{org}/group/{name}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"memberLinks\": [\n \"<string>\"\n ],\n \"$drop/memberLinks\": [\n \"<string>\"\n ],\n \"$append/memberLinks\": [\n \"<string>\"\n ],\n \"$retain/memberLinks\": [\n \"<string>\"\n ],\n \"memberQuery\": {\n \"$drop\": [],\n \"kind\": \"<string>\",\n \"spec\": {\n \"$drop\": [],\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$drop/terms\": [\n \"<string>\"\n ],\n \"$append/terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$patch/terms\": [\n {\n \"$drop\": [],\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"$replace/value\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"$retain/terms\": [\n \"<string>\"\n ],\n \"sort\": {\n \"$drop\": [],\n \"by\": \"<string>\",\n \"order\": \"asc\"\n },\n \"$replace/sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n },\n \"$replace/spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"$replace/memberQuery\": {\n \"kind\": \"<string>\",\n \"spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"identityMatcher\": {\n \"$drop\": [],\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n },\n \"$replace/identityMatcher\": {\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cpln.io/org/{org}/group/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"memberLinks\": [\n \"<string>\"\n ],\n \"$drop/memberLinks\": [\n \"<string>\"\n ],\n \"$append/memberLinks\": [\n \"<string>\"\n ],\n \"$retain/memberLinks\": [\n \"<string>\"\n ],\n \"memberQuery\": {\n \"$drop\": [],\n \"kind\": \"<string>\",\n \"spec\": {\n \"$drop\": [],\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$drop/terms\": [\n \"<string>\"\n ],\n \"$append/terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$patch/terms\": [\n {\n \"$drop\": [],\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"$replace/value\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"$retain/terms\": [\n \"<string>\"\n ],\n \"sort\": {\n \"$drop\": [],\n \"by\": \"<string>\",\n \"order\": \"asc\"\n },\n \"$replace/sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n },\n \"$replace/spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"$replace/memberQuery\": {\n \"kind\": \"<string>\",\n \"spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"identityMatcher\": {\n \"$drop\": [],\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n },\n \"$replace/identityMatcher\": {\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}Group
Perform a Patch on a group by name
PATCH
/
org
/
{org}
/
group
/
{name}
Perform a Patch on a group by name
curl --request PATCH \
--url https://api.cpln.io/org/{org}/group/{name} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"$drop": [],
"name": "<string>",
"description": "<string>",
"tags": {},
"$replace/tags": {},
"memberLinks": [
"<string>"
],
"$drop/memberLinks": [
"<string>"
],
"$append/memberLinks": [
"<string>"
],
"$retain/memberLinks": [
"<string>"
],
"memberQuery": {
"$drop": [],
"kind": "<string>",
"spec": {
"$drop": [],
"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": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"$replace/value": "<string>",
"value": "<unknown>"
}
],
"$retain/terms": [
"<string>"
],
"sort": {
"$drop": [],
"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": "<string>",
"language": "jmespath"
},
"$replace/identityMatcher": {
"expression": "<string>",
"language": "jmespath"
}
}
'import requests
url = "https://api.cpln.io/org/{org}/group/{name}"
payload = {
"$drop": [],
"name": "<string>",
"description": "<string>",
"tags": {},
"$replace/tags": {},
"memberLinks": ["<string>"],
"$drop/memberLinks": ["<string>"],
"$append/memberLinks": ["<string>"],
"$retain/memberLinks": ["<string>"],
"memberQuery": {
"$drop": [],
"kind": "<string>",
"spec": {
"$drop": [],
"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": "=",
"property": "<string>",
"rel": "<string>",
"tag": "<string>",
"$replace/value": "<string>",
"value": "<unknown>"
}
],
"$retain/terms": ["<string>"],
"sort": {
"$drop": [],
"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": "<string>",
"language": "jmespath"
},
"$replace/identityMatcher": {
"expression": "<string>",
"language": "jmespath"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
$drop: [],
name: '<string>',
description: '<string>',
tags: {},
'$replace/tags': {},
memberLinks: ['<string>'],
'$drop/memberLinks': ['<string>'],
'$append/memberLinks': ['<string>'],
'$retain/memberLinks': ['<string>'],
memberQuery: {
$drop: [],
kind: '<string>',
spec: {
$drop: [],
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: '=',
property: '<string>',
rel: '<string>',
tag: '<string>',
'$replace/value': '<string>',
value: '<unknown>'
}
],
'$retain/terms': ['<string>'],
sort: {$drop: [], 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: '<string>', language: 'jmespath'},
'$replace/identityMatcher': {expression: '<string>', language: 'jmespath'}
})
};
fetch('https://api.cpln.io/org/{org}/group/{name}', 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.cpln.io/org/{org}/group/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'$drop' => [
],
'name' => '<string>',
'description' => '<string>',
'tags' => [
],
'$replace/tags' => [
],
'memberLinks' => [
'<string>'
],
'$drop/memberLinks' => [
'<string>'
],
'$append/memberLinks' => [
'<string>'
],
'$retain/memberLinks' => [
'<string>'
],
'memberQuery' => [
'$drop' => [
],
'kind' => '<string>',
'spec' => [
'$drop' => [
],
'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' => '=',
'property' => '<string>',
'rel' => '<string>',
'tag' => '<string>',
'$replace/value' => '<string>',
'value' => '<unknown>'
]
],
'$retain/terms' => [
'<string>'
],
'sort' => [
'$drop' => [
],
'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' => '<string>',
'language' => 'jmespath'
],
'$replace/identityMatcher' => [
'expression' => '<string>',
'language' => 'jmespath'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.cpln.io/org/{org}/group/{name}"
payload := strings.NewReader("{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"memberLinks\": [\n \"<string>\"\n ],\n \"$drop/memberLinks\": [\n \"<string>\"\n ],\n \"$append/memberLinks\": [\n \"<string>\"\n ],\n \"$retain/memberLinks\": [\n \"<string>\"\n ],\n \"memberQuery\": {\n \"$drop\": [],\n \"kind\": \"<string>\",\n \"spec\": {\n \"$drop\": [],\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$drop/terms\": [\n \"<string>\"\n ],\n \"$append/terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$patch/terms\": [\n {\n \"$drop\": [],\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"$replace/value\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"$retain/terms\": [\n \"<string>\"\n ],\n \"sort\": {\n \"$drop\": [],\n \"by\": \"<string>\",\n \"order\": \"asc\"\n },\n \"$replace/sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n },\n \"$replace/spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"$replace/memberQuery\": {\n \"kind\": \"<string>\",\n \"spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"identityMatcher\": {\n \"$drop\": [],\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n },\n \"$replace/identityMatcher\": {\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.patch("https://api.cpln.io/org/{org}/group/{name}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"memberLinks\": [\n \"<string>\"\n ],\n \"$drop/memberLinks\": [\n \"<string>\"\n ],\n \"$append/memberLinks\": [\n \"<string>\"\n ],\n \"$retain/memberLinks\": [\n \"<string>\"\n ],\n \"memberQuery\": {\n \"$drop\": [],\n \"kind\": \"<string>\",\n \"spec\": {\n \"$drop\": [],\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$drop/terms\": [\n \"<string>\"\n ],\n \"$append/terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$patch/terms\": [\n {\n \"$drop\": [],\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"$replace/value\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"$retain/terms\": [\n \"<string>\"\n ],\n \"sort\": {\n \"$drop\": [],\n \"by\": \"<string>\",\n \"order\": \"asc\"\n },\n \"$replace/sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n },\n \"$replace/spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"$replace/memberQuery\": {\n \"kind\": \"<string>\",\n \"spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"identityMatcher\": {\n \"$drop\": [],\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n },\n \"$replace/identityMatcher\": {\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cpln.io/org/{org}/group/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"$drop\": [],\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": {},\n \"$replace/tags\": {},\n \"memberLinks\": [\n \"<string>\"\n ],\n \"$drop/memberLinks\": [\n \"<string>\"\n ],\n \"$append/memberLinks\": [\n \"<string>\"\n ],\n \"$retain/memberLinks\": [\n \"<string>\"\n ],\n \"memberQuery\": {\n \"$drop\": [],\n \"kind\": \"<string>\",\n \"spec\": {\n \"$drop\": [],\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$drop/terms\": [\n \"<string>\"\n ],\n \"$append/terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"$patch/terms\": [\n {\n \"$drop\": [],\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"$replace/value\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"$retain/terms\": [\n \"<string>\"\n ],\n \"sort\": {\n \"$drop\": [],\n \"by\": \"<string>\",\n \"order\": \"asc\"\n },\n \"$replace/sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n },\n \"$replace/spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"$replace/memberQuery\": {\n \"kind\": \"<string>\",\n \"spec\": {\n \"match\": \"all\",\n \"terms\": [\n {\n \"op\": \"=\",\n \"property\": \"<string>\",\n \"rel\": \"<string>\",\n \"tag\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort\": {\n \"by\": \"<string>\",\n \"order\": \"asc\"\n }\n }\n },\n \"identityMatcher\": {\n \"$drop\": [],\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n },\n \"$replace/identityMatcher\": {\n \"expression\": \"<string>\",\n \"language\": \"jmespath\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}Authorizations
serviceAccountKeyjwt
Service account key can be used as API keys
Body
application/json
Available options:
description, tags, memberLinks, memberQuery, identityMatcher Maximum string length:
64Maximum string length:
250Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Success
Maximum string length:
64Maximum string length:
250Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
synthetic, default, builtin ⌘I