PATCH
/
org
/
{org}
/
domain
/
{name}
curl --request PATCH \
  --url https://api.cpln.io/org/{org}/domain/{name} \
  --header 'Content-Type: application/json' \
  --data '{
  "$drop": [
    "description"
  ],
  "description": "<string>",
  "tags": {},
  "$replace/tags": {},
  "name": "<string>",
  "spec": {
    "$drop": [
      "dnsMode"
    ],
    "dnsMode": "cname",
    "gvcLink": "<string>",
    "acceptAllHosts": true,
    "ports": [
      {
        "number": 123,
        "protocol": "http",
        "routes": [
          {
            "replacePrefix": "<string>",
            "regex": "<string>",
            "prefix": "<string>",
            "workloadLink": "<string>",
            "port": 123,
            "hostPrefix": "<string>"
          }
        ],
        "cors": {
          "allowOrigins": [
            {
              "exact": "<string>"
            }
          ],
          "allowMethods": [
            "<string>"
          ],
          "allowHeaders": [
            "<string>"
          ],
          "exposeHeaders": [
            "<string>"
          ],
          "maxAge": "<string>",
          "allowCredentials": true
        },
        "tls": {
          "minProtocolVersion": "TLSV1_2",
          "cipherSuites": [
            "ECDHE-ECDSA-AES256-GCM-SHA384"
          ],
          "clientCertificate": {
            "secretLink": "<string>"
          },
          "serverCertificate": {
            "secretLink": "<string>"
          }
        }
      }
    ],
    "$drop/ports": [
      "<string>"
    ],
    "$append/ports": [
      {
        "number": 123,
        "protocol": "http",
        "routes": [
          {
            "replacePrefix": "<string>",
            "regex": "<string>",
            "prefix": "<string>",
            "workloadLink": "<string>",
            "port": 123,
            "hostPrefix": "<string>"
          }
        ],
        "cors": {
          "allowOrigins": [
            {
              "exact": "<string>"
            }
          ],
          "allowMethods": [
            "<string>"
          ],
          "allowHeaders": [
            "<string>"
          ],
          "exposeHeaders": [
            "<string>"
          ],
          "maxAge": "<string>",
          "allowCredentials": true
        },
        "tls": {
          "minProtocolVersion": "TLSV1_2",
          "cipherSuites": [
            "ECDHE-ECDSA-AES256-GCM-SHA384"
          ],
          "clientCertificate": {
            "secretLink": "<string>"
          },
          "serverCertificate": {
            "secretLink": "<string>"
          }
        }
      }
    ],
    "$patch/ports": [
      {
        "$drop": [
          "number"
        ],
        "number": 123,
        "protocol": "http",
        "routes": [
          {
            "replacePrefix": "<string>",
            "regex": "<string>",
            "prefix": "<string>",
            "workloadLink": "<string>",
            "port": 123,
            "hostPrefix": "<string>"
          }
        ],
        "$drop/routes": [
          "<string>"
        ],
        "$append/routes": [
          {
            "replacePrefix": "<string>",
            "regex": "<string>",
            "prefix": "<string>",
            "workloadLink": "<string>",
            "port": 123,
            "hostPrefix": "<string>"
          }
        ],
        "$patch/routes": [
          {
            "$drop": [
              "replacePrefix"
            ],
            "replacePrefix": "<string>",
            "regex": "<string>",
            "prefix": "<string>",
            "workloadLink": "<string>",
            "port": 123,
            "hostPrefix": "<string>"
          }
        ],
        "$retain/routes": [
          "<string>"
        ],
        "cors": {
          "$drop": [
            "allowOrigins"
          ],
          "allowOrigins": [
            {
              "exact": "<string>"
            }
          ],
          "$drop/allowOrigins": [
            "<string>"
          ],
          "$append/allowOrigins": [
            {
              "exact": "<string>"
            }
          ],
          "$patch/allowOrigins": [
            {
              "$drop": [
                "exact"
              ],
              "exact": "<string>"
            }
          ],
          "$retain/allowOrigins": [
            "<string>"
          ],
          "allowMethods": [
            "<string>"
          ],
          "$drop/allowMethods": [
            "<string>"
          ],
          "$append/allowMethods": [
            "<string>"
          ],
          "$retain/allowMethods": [
            "<string>"
          ],
          "allowHeaders": [
            "<string>"
          ],
          "$drop/allowHeaders": [
            "<string>"
          ],
          "$append/allowHeaders": [
            "<string>"
          ],
          "$retain/allowHeaders": [
            "<string>"
          ],
          "exposeHeaders": [
            "<string>"
          ],
          "$drop/exposeHeaders": [
            "<string>"
          ],
          "$append/exposeHeaders": [
            "<string>"
          ],
          "$retain/exposeHeaders": [
            "<string>"
          ],
          "maxAge": "<string>",
          "allowCredentials": true
        },
        "$replace/cors": {
          "allowOrigins": [
            {
              "exact": "<string>"
            }
          ],
          "allowMethods": [
            "<string>"
          ],
          "allowHeaders": [
            "<string>"
          ],
          "exposeHeaders": [
            "<string>"
          ],
          "maxAge": "<string>",
          "allowCredentials": true
        },
        "tls": {
          "$drop": [
            "minProtocolVersion"
          ],
          "minProtocolVersion": "TLSV1_2",
          "cipherSuites": [
            "ECDHE-ECDSA-AES256-GCM-SHA384"
          ],
          "$drop/cipherSuites": [
            "ECDHE-ECDSA-AES256-GCM-SHA384"
          ],
          "$append/cipherSuites": [
            "ECDHE-ECDSA-AES256-GCM-SHA384"
          ],
          "$retain/cipherSuites": [
            "ECDHE-ECDSA-AES256-GCM-SHA384"
          ],
          "clientCertificate": {
            "$drop": [
              "secretLink"
            ],
            "secretLink": "<string>"
          },
          "$replace/clientCertificate": {
            "secretLink": "<string>"
          },
          "serverCertificate": {
            "$drop": [
              "secretLink"
            ],
            "secretLink": "<string>"
          },
          "$replace/serverCertificate": {
            "secretLink": "<string>"
          }
        },
        "$replace/tls": {
          "minProtocolVersion": "TLSV1_2",
          "cipherSuites": [
            "ECDHE-ECDSA-AES256-GCM-SHA384"
          ],
          "clientCertificate": {
            "secretLink": "<string>"
          },
          "serverCertificate": {
            "secretLink": "<string>"
          }
        }
      }
    ],
    "$retain/ports": [
      "<string>"
    ]
  },
  "$replace/spec": {
    "dnsMode": "cname",
    "gvcLink": "<string>",
    "acceptAllHosts": true,
    "ports": [
      {
        "number": 123,
        "protocol": "http",
        "routes": [
          {
            "replacePrefix": "<string>",
            "regex": "<string>",
            "prefix": "<string>",
            "workloadLink": "<string>",
            "port": 123,
            "hostPrefix": "<string>"
          }
        ],
        "cors": {
          "allowOrigins": [
            {
              "exact": "<string>"
            }
          ],
          "allowMethods": [
            "<string>"
          ],
          "allowHeaders": [
            "<string>"
          ],
          "exposeHeaders": [
            "<string>"
          ],
          "maxAge": "<string>",
          "allowCredentials": true
        },
        "tls": {
          "minProtocolVersion": "TLSV1_2",
          "cipherSuites": [
            "ECDHE-ECDSA-AES256-GCM-SHA384"
          ],
          "clientCertificate": {
            "secretLink": "<string>"
          },
          "serverCertificate": {
            "secretLink": "<string>"
          }
        }
      }
    ]
  }
}'
{
  "id": "<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>"
    }
  ],
  "name": "<string>",
  "spec": {
    "dnsMode": "cname",
    "gvcLink": "<string>",
    "acceptAllHosts": true,
    "ports": [
      {
        "number": 123,
        "protocol": "http",
        "routes": [
          {
            "replacePrefix": "<string>",
            "regex": "<string>",
            "prefix": "<string>",
            "workloadLink": "<string>",
            "port": 123,
            "hostPrefix": "<string>"
          }
        ],
        "cors": {
          "allowOrigins": [
            {
              "exact": "<string>"
            }
          ],
          "allowMethods": [
            "<string>"
          ],
          "allowHeaders": [
            "<string>"
          ],
          "exposeHeaders": [
            "<string>"
          ],
          "maxAge": "<string>",
          "allowCredentials": true
        },
        "tls": {
          "minProtocolVersion": "TLSV1_2",
          "cipherSuites": [
            "ECDHE-ECDSA-AES256-GCM-SHA384"
          ],
          "clientCertificate": {
            "secretLink": "<string>"
          },
          "serverCertificate": {
            "secretLink": "<string>"
          }
        }
      }
    ]
  },
  "status": {
    "endpoints": [
      {
        "url": "<string>",
        "workloadLink": "<string>"
      }
    ],
    "status": "initializing",
    "warning": "<string>",
    "locations": [
      {
        "name": "<string>",
        "certificateStatus": "initializing"
      }
    ],
    "fingerprint": "<string>",
    "dnsConfig": [
      {
        "type": "<string>",
        "ttl": 123,
        "host": "<string>",
        "value": "<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,
spec
description
string
tags
object
$replace/tags
object
name
string
spec
object
$replace/spec
object

Response

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