org
Get an org by name
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
org
Get an org by name
Response will contain the requested org if the caller is authorized to view it
GET
/
org
/
{name}
curl --request GET \
--url https://api.cpln.io/org/{name}
{
"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": {
"logging": {
"s3": {
"bucket": "<string>",
"region": "<string>",
"prefix": "/",
"credentials": "<string>"
},
"coralogix": {
"cluster": "coralogix.com",
"credentials": "<string>",
"app": "<string>",
"subsystem": "<string>"
},
"datadog": {
"host": "http-intake.logs.datadoghq.com",
"credentials": "<string>"
},
"logzio": {
"listenerHost": "listener.logz.io",
"credentials": "<string>"
},
"elastic": {
"aws": {
"host": "<string>",
"port": 123,
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"region": "<string>"
},
"elasticCloud": {
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"cloudId": "<string>"
},
"generic": {
"host": "<string>",
"port": 123,
"path": "<string>",
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"username": "<string>",
"password": "<string>"
}
},
"cloudWatch": {
"region": "us-east-1",
"credentials": "<string>",
"retentionDays": 123,
"groupName": "<string>",
"streamName": "<string>",
"extractFields": {}
},
"fluentd": {
"host": "<string>",
"port": 123
},
"stackdriver": {
"credentials": "<string>",
"location": "us-east1"
},
"syslog": {
"host": "<string>",
"port": 123,
"mode": "tcp",
"format": "rfc5424",
"severity": 123
}
},
"extraLogging": [
{
"s3": {
"bucket": "<string>",
"region": "<string>",
"prefix": "/",
"credentials": "<string>"
},
"coralogix": {
"cluster": "coralogix.com",
"credentials": "<string>",
"app": "<string>",
"subsystem": "<string>"
},
"datadog": {
"host": "http-intake.logs.datadoghq.com",
"credentials": "<string>"
},
"logzio": {
"listenerHost": "listener.logz.io",
"credentials": "<string>"
},
"elastic": {
"aws": {
"host": "<string>",
"port": 123,
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"region": "<string>"
},
"elasticCloud": {
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"cloudId": "<string>"
},
"generic": {
"host": "<string>",
"port": 123,
"path": "<string>",
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"username": "<string>",
"password": "<string>"
}
},
"cloudWatch": {
"region": "us-east-1",
"credentials": "<string>",
"retentionDays": 123,
"groupName": "<string>",
"streamName": "<string>",
"extractFields": {}
},
"fluentd": {
"host": "<string>",
"port": 123
},
"stackdriver": {
"credentials": "<string>",
"location": "us-east1"
},
"syslog": {
"host": "<string>",
"port": 123,
"mode": "tcp",
"format": "rfc5424",
"severity": 123
}
}
],
"tracing": {
"sampling": 123,
"lightstep": {
"endpoint": "<string>",
"credentials": "<string>"
},
"customTags": {},
"provider": {
"otel": {
"endpoint": "<string>"
},
"lightstep": {
"endpoint": "<string>",
"credentials": "<string>"
},
"controlplane": {}
}
},
"sessionTimeoutSeconds": 123,
"authConfig": {
"domainAutoMembers": [
"<string>"
],
"samlOnly": true
},
"observability": {
"logsRetentionDays": 123,
"metricsRetentionDays": 123,
"tracesRetentionDays": 123,
"defaultAlertEmails": [
"<string>"
]
},
"security": {
"threatDetection": {
"enabled": true,
"minimumSeverity": "warning",
"syslog": {
"transport": "tcp",
"host": "<string>",
"port": 123
}
}
}
},
"status": {
"accountLink": "<string>",
"active": true,
"endpointPrefix": "<string>"
}
}
Authorizations
Service account key can be used as API keys
Path Parameters
Response
200
application/json
Success
The response is of type object
.
curl --request GET \
--url https://api.cpln.io/org/{name}
{
"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": {
"logging": {
"s3": {
"bucket": "<string>",
"region": "<string>",
"prefix": "/",
"credentials": "<string>"
},
"coralogix": {
"cluster": "coralogix.com",
"credentials": "<string>",
"app": "<string>",
"subsystem": "<string>"
},
"datadog": {
"host": "http-intake.logs.datadoghq.com",
"credentials": "<string>"
},
"logzio": {
"listenerHost": "listener.logz.io",
"credentials": "<string>"
},
"elastic": {
"aws": {
"host": "<string>",
"port": 123,
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"region": "<string>"
},
"elasticCloud": {
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"cloudId": "<string>"
},
"generic": {
"host": "<string>",
"port": 123,
"path": "<string>",
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"username": "<string>",
"password": "<string>"
}
},
"cloudWatch": {
"region": "us-east-1",
"credentials": "<string>",
"retentionDays": 123,
"groupName": "<string>",
"streamName": "<string>",
"extractFields": {}
},
"fluentd": {
"host": "<string>",
"port": 123
},
"stackdriver": {
"credentials": "<string>",
"location": "us-east1"
},
"syslog": {
"host": "<string>",
"port": 123,
"mode": "tcp",
"format": "rfc5424",
"severity": 123
}
},
"extraLogging": [
{
"s3": {
"bucket": "<string>",
"region": "<string>",
"prefix": "/",
"credentials": "<string>"
},
"coralogix": {
"cluster": "coralogix.com",
"credentials": "<string>",
"app": "<string>",
"subsystem": "<string>"
},
"datadog": {
"host": "http-intake.logs.datadoghq.com",
"credentials": "<string>"
},
"logzio": {
"listenerHost": "listener.logz.io",
"credentials": "<string>"
},
"elastic": {
"aws": {
"host": "<string>",
"port": 123,
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"region": "<string>"
},
"elasticCloud": {
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"cloudId": "<string>"
},
"generic": {
"host": "<string>",
"port": 123,
"path": "<string>",
"index": "<string>",
"type": "<string>",
"credentials": "<string>",
"username": "<string>",
"password": "<string>"
}
},
"cloudWatch": {
"region": "us-east-1",
"credentials": "<string>",
"retentionDays": 123,
"groupName": "<string>",
"streamName": "<string>",
"extractFields": {}
},
"fluentd": {
"host": "<string>",
"port": 123
},
"stackdriver": {
"credentials": "<string>",
"location": "us-east1"
},
"syslog": {
"host": "<string>",
"port": 123,
"mode": "tcp",
"format": "rfc5424",
"severity": 123
}
}
],
"tracing": {
"sampling": 123,
"lightstep": {
"endpoint": "<string>",
"credentials": "<string>"
},
"customTags": {},
"provider": {
"otel": {
"endpoint": "<string>"
},
"lightstep": {
"endpoint": "<string>",
"credentials": "<string>"
},
"controlplane": {}
}
},
"sessionTimeoutSeconds": 123,
"authConfig": {
"domainAutoMembers": [
"<string>"
],
"samlOnly": true
},
"observability": {
"logsRetentionDays": 123,
"metricsRetentionDays": 123,
"tracesRetentionDays": 123,
"defaultAlertEmails": [
"<string>"
]
},
"security": {
"threatDetection": {
"enabled": true,
"minimumSeverity": "warning",
"syslog": {
"transport": "tcp",
"host": "<string>",
"port": 123
}
}
}
},
"status": {
"accountLink": "<string>",
"active": true,
"endpointPrefix": "<string>"
}
}