PATCH
/
org
/
{org}
/
secret
/
{name}
curl --request PATCH \
  --url https://api.cpln.io/org/{org}/secret/{name} \
  --header 'Content-Type: application/json' \
  --data '{
  "$drop": [
    "description"
  ],
  "description": "<string>",
  "tags": {},
  "$replace/tags": {},
  "spec": {
    "$drop": [
      "link"
    ],
    "link": "<string>",
    "locations": [
      {
        "name": "<string>",
        "retentionPolicy": "keep"
      }
    ],
    "$drop/locations": [
      "<string>"
    ],
    "$append/locations": [
      {
        "name": "<string>",
        "retentionPolicy": "keep"
      }
    ],
    "$retain/locations": [
      "<string>"
    ],
    "$patch/locations": [
      {
        "$drop": [
          "retentionPolicy"
        ],
        "name": "<string>",
        "retentionPolicy": "keep"
      }
    ]
  },
  "$replace/spec": {
    "link": "<string>",
    "locations": [
      {
        "name": "<string>",
        "retentionPolicy": "keep"
      }
    ]
  }
}'
{
  "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>"
    }
  ],
  "spec": {
    "link": "<string>",
    "locations": [
      {
        "name": "<string>",
        "retentionPolicy": "keep"
      }
    ]
  },
  "status": {
    "ipAddresses": [
      {
        "name": "<string>",
        "ip": "<string>",
        "id": "<string>",
        "state": "bound",
        "created": "2023-11-07T05:31:56Z"
      }
    ],
    "error": "<string>"
  }
}

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
$drop
enum<string>[]
Available options:
description,
tags,
spec
description
string
Maximum length: 250
tags
object
$replace/tags
object
spec
object
$replace/spec
object

Response

200
application/json
Success
id
string
name
string
Maximum length: 64
kind
string
version
integer
description
string
Maximum length: 250
tags
object
created
string
lastModified
string
spec
object
status
object