POST
/
org
/
{org}
/
agent
curl --request POST \
  --url https://api.cpln.io/org/{org}/agent \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "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
header
required

Service account key can be used as API keys

Path Parameters

org
string
required

Body

application/json
description
string
Maximum length: 250
tags
object
status
object

Response

201
application/json
The agent was created successfully. The Response will contain the bootstrap config JSON text that is required when configuring an agent at a cloud provider.
id
string
name
string
Maximum length: 64
kind
string
version
integer
description
string
Maximum length: 250
tags
object
created
string
lastModified
string
status
object