Overview
agent
auditctx
cloudaccount
- GETGet a cloud account by name
- DELDelete an cloud account by name
- PATCHPerform a Patch on a cloud account by name
- GETGet all cloud accounts
- POSTCreate a cloud account
- POSTGet all cloud accounts based on a query
- GETGet the access report for a cloud account by name
- GETGet available permissions for a cloud account resource type
domain
group
gvc
identity
- GETGet an identity by GVC and name
- DELDelete an identity by GVC and name
- PATCHPerform a Patch on an identity by name
- GETGet all identities in a GVC
- POSTCreate an identity
- GETGet all identities from all GVCs
- POSTGet all GVC identities based on a query
- GETGet the access report for an identity by GVC and name
- GETGet available permissions for an identity
image
location
org
policy
quota
secret
- GETGet a secret by name
- DELDelete a secret by name
- PATCHPerform a Patch on an IP Set by name
- GETGet all secrets
- POSTCreate a secret
- GETGet the sensitive content of a secret by name
- POSTGet all secrets based on a query
- GETGet the access report for a secret by name
- GETGet available permissions for a secret resource type
serviceaccount
- GETGet a service account by name
- DELDelete a service account by name
- PATCHPerform a Patch on a service account by name
- GETGet all service accounts
- POSTCreate a service account
- POSTGet all service accounts based on a query
- GETGet the access report for a service account by name
- POSTAdd a key to a service account
- GETGet available permissions for a service account resource type
task
user
volumeset
- GETGet a volumeset by GVC and name
- DELDelete a volumeset by name
- PATCHPerform a Patch on a volumeset by name
- GETList volumesets in a GVC you are authorized to view
- POSTCreate a volumeset
- GETGet all volumesets
- POSTGet all volumesets based on a query
- GETGet the access report for a volumeset by GVC and name
- GETGet available permissions for a volumeset resource type
workload
- GETGet a workload by GVC and name
- DELDelete a workload by name
- PATCHPerform a Patch on a workload by name
- GETGet a deployment by GVC, workload and name
- GETList workloads in a GVC you are authorized to view
- POSTCreate a workload
- GETGet all workloads
- GETList deployments in a workload
- POSTGet all workloads based on a query
- GETGet the access report for a workload by GVC and name
- GETGet available permissions for a workload resource type
domain
Create a domain
POST
/
org
/
{org}
/
domain
curl --request POST \
--url https://api.cpln.io/org/{org}/domain \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"tags": {},
"name": "<string>",
"spec": {
"dnsMode": "cname",
"gvcLink": "<string>",
"certChallengeType": "http01",
"workloadLink": "<string>",
"acceptAllHosts": true,
"ports": [
{
"number": 123,
"protocol": "http2",
"routes": [
{
"replacePrefix": "<string>",
"regex": "<string>",
"prefix": "<string>",
"workloadLink": "<string>",
"port": 123,
"hostPrefix": "<string>",
"hostRegex": "<string>",
"headers": {
"request": {
"set": {}
}
},
"replica": 123
}
],
"cors": {
"allowOrigins": [
{
"exact": "<string>",
"regex": "<string>"
}
],
"allowMethods": [
"<string>"
],
"allowHeaders": [
"<string>"
],
"exposeHeaders": [
"<string>"
],
"maxAge": "<string>",
"allowCredentials": true
},
"tls": {
"minProtocolVersion": "TLSV1_2",
"cipherSuites": [
[
"ECDHE-ECDSA-AES256-GCM-SHA384",
"ECDHE-ECDSA-CHACHA20-POLY1305",
"ECDHE-ECDSA-AES128-GCM-SHA256",
"ECDHE-RSA-AES256-GCM-SHA384",
"ECDHE-RSA-CHACHA20-POLY1305",
"ECDHE-RSA-AES128-GCM-SHA256",
"AES256-GCM-SHA384",
"AES128-GCM-SHA256"
]
],
"clientCertificate": {
"secretLink": "<string>"
},
"serverCertificate": {
"secretLink": "<string>"
}
}
}
]
}
}'
"<any>"
Authorizations
Service account key can be used as API keys
Path Parameters
Body
application/json
The body is of type object
.
Response
201
application/json
Domain was created successfully
The response is of type any
.
curl --request POST \
--url https://api.cpln.io/org/{org}/domain \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"tags": {},
"name": "<string>",
"spec": {
"dnsMode": "cname",
"gvcLink": "<string>",
"certChallengeType": "http01",
"workloadLink": "<string>",
"acceptAllHosts": true,
"ports": [
{
"number": 123,
"protocol": "http2",
"routes": [
{
"replacePrefix": "<string>",
"regex": "<string>",
"prefix": "<string>",
"workloadLink": "<string>",
"port": 123,
"hostPrefix": "<string>",
"hostRegex": "<string>",
"headers": {
"request": {
"set": {}
}
},
"replica": 123
}
],
"cors": {
"allowOrigins": [
{
"exact": "<string>",
"regex": "<string>"
}
],
"allowMethods": [
"<string>"
],
"allowHeaders": [
"<string>"
],
"exposeHeaders": [
"<string>"
],
"maxAge": "<string>",
"allowCredentials": true
},
"tls": {
"minProtocolVersion": "TLSV1_2",
"cipherSuites": [
[
"ECDHE-ECDSA-AES256-GCM-SHA384",
"ECDHE-ECDSA-CHACHA20-POLY1305",
"ECDHE-ECDSA-AES128-GCM-SHA256",
"ECDHE-RSA-AES256-GCM-SHA384",
"ECDHE-RSA-CHACHA20-POLY1305",
"ECDHE-RSA-AES128-GCM-SHA256",
"AES256-GCM-SHA384",
"AES128-GCM-SHA256"
]
],
"clientCertificate": {
"secretLink": "<string>"
},
"serverCertificate": {
"secretLink": "<string>"
}
}
}
]
}
}'
"<any>"
Assistant
Responses are generated using AI and may contain mistakes.