PATCH
/
org
/
{org}
/
agent
/
{name}
curl --request PATCH \
  --url https://api.cpln.io/org/{org}/agent/{name} \
  --header 'Content-Type: application/json' \
  --data '{
  "$drop": [
    "description"
  ],
  "description": "<string>",
  "tags": {},
  "$replace/tags": {}
}'
{
  "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>"
    }
  ],
  "status": {
    "bootstrapConfig": {
      "registrationToken": "<string>",
      "agentId": "<string>",
      "agentLink": "<string>",
      "hubEndpoint": "<string>"
    }
  }
}

Authorizations

Authorization
string
headerrequired

Service account key can be used as API keys

Path Parameters

org
string
required
name
string
required

Body

application/json
$drop
enum<string>[]
Available options:
description,
tags
description
string
tags
object
$replace/tags
object

Response

200 - application/json
id
string
name
string
kind
string
version
integer
description
string
tags
object
created
string
lastModified
string
links
object[]
status
object