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
Perform a Patch on a volumeset by name
curl --request PATCH \
--url https://api.cpln.io/org/{org}/gvc/{gvc}/volumeset/{name} \
--header 'Content-Type: application/json' \
--data '{
"$drop": [
"description"
],
"description": "<string>",
"tags": {},
"$replace/tags": {},
"spec": {
"$drop": [
"initialCapacity"
],
"initialCapacity": 123,
"performanceClass": "general-purpose-ssd",
"storageClassSuffix": "<string>",
"fileSystemType": "ext4",
"snapshots": {
"$drop": [
"createFinalSnapshot"
],
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"$replace/snapshots": {
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"autoscaling": {
"$drop": [
"maxCapacity"
],
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"$replace/autoscaling": {
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"mountOptions": {
"$drop": [
"resources"
],
"resources": {
"$drop": [
"maxCpu"
],
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
},
"$replace/resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
},
"$replace/mountOptions": {
"resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
}
},
"$replace/spec": {
"initialCapacity": 123,
"performanceClass": "general-purpose-ssd",
"storageClassSuffix": "<string>",
"fileSystemType": "ext4",
"snapshots": {
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"autoscaling": {
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"mountOptions": {
"resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
}
},
"gvc": {},
"$replace/gvc": {}
}'{
"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": {
"initialCapacity": 123,
"performanceClass": "general-purpose-ssd",
"storageClassSuffix": "<string>",
"fileSystemType": "ext4",
"snapshots": {
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"autoscaling": {
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"mountOptions": {
"resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
}
},
"status": {
"parentId": "<string>",
"usedByWorkload": "<string>",
"workloadLinks": [
"<string>"
],
"bindingId": "<string>",
"locations": [
{
"name": "<string>",
"volumes": [
{
"lifecycle": "creating",
"storageDeviceId": "<string>",
"oldStorageDeviceIds": [
"<string>"
],
"resourceName": "<string>",
"index": 123,
"currentSize": 123,
"currentBytesUsed": 123,
"iops": 123,
"throughput": 123,
"driver": "<string>",
"volumeSnapshots": [
{
"name": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"expires": "2023-11-07T05:31:56Z",
"size": 123,
"tags": [
{}
]
}
],
"attributes": {},
"zone": "<string>"
}
],
"desiredVolumeCount": 123,
"clusterId": "<string>"
}
]
},
"gvc": {}
}Authorizations
Service account key can be used as API keys
Body
description, tags, spec, gvc 250initialCapacity, performanceClass, storageClassSuffix, fileSystemType, snapshots, autoscaling, mountOptions The initial size in GB of volumes in this set.
general-purpose-ssd, high-throughput-ssd, shared For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
ext4, xfs, shared createFinalSnapshot, retentionDuration, schedule If true, a volume snapshot will be created immediately before deletion of any volume in this set
The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
A standard cron schedule expression used to determine when your job should execute.
If true, a volume snapshot will be created immediately before deletion of any volume in this set
The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
A standard cron schedule expression used to determine when your job should execute.
maxCapacity, minFreePercentage, scalingFactor The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this.
The guaranteed free space on the volume as a percentage of the volume's total size. ControlPlane will try to maintain at least that many percent free by scaling up the total size
When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor.
The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this.
The guaranteed free space on the volume as a percentage of the volume's total size. ControlPlane will try to maintain at least that many percent free by scaling up the total size
When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor.
resources maxCpu, minCpu, minMemory, maxMemory 20202020For volume sets using the shared file system, this object specifies the CPU and memory resources allotted to each mount point
20202020A list of mount options to use when mounting volumes in this set.
For volume sets using the shared file system, this object specifies the CPU and memory resources allotted to each mount point
20202020The initial size in GB of volumes in this set.
general-purpose-ssd, high-throughput-ssd, shared For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
ext4, xfs, shared If true, a volume snapshot will be created immediately before deletion of any volume in this set
The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
A standard cron schedule expression used to determine when your job should execute.
The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this.
The guaranteed free space on the volume as a percentage of the volume's total size. ControlPlane will try to maintain at least that many percent free by scaling up the total size
When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor.
A list of mount options to use when mounting volumes in this set.
For volume sets using the shared file system, this object specifies the CPU and memory resources allotted to each mount point
20202020Response
64250The initial size in GB of volumes in this set.
general-purpose-ssd, high-throughput-ssd, shared For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
ext4, xfs, shared If true, a volume snapshot will be created immediately before deletion of any volume in this set
The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
A standard cron schedule expression used to determine when your job should execute.
The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this.
The guaranteed free space on the volume as a percentage of the volume's total size. ControlPlane will try to maintain at least that many percent free by scaling up the total size
When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor.
A list of mount options to use when mounting volumes in this set.
For volume sets using the shared file system, this object specifies the CPU and memory resources allotted to each mount point
The name of the location in which this volume was provisioned
creating, unused, unbound, bound, deleted, repairing The id of the volume as provided by the underlying storage implementation. If this is blank, an actual storage device has not yet been created.
The most recently used storageDeviceId. This is meant for use by Control Plane only
This number is used to order volumes within the volume set. It is used by Control Plane to link volumes with the workload replicas that use them.
The current capacity of the volume in GB
The total bytes used in the volume.
The name of the CSI driver used to provision and manage this volume
A human-readable name for this snapshot.
The id of the snapshot as provided by the underlying storage implementation.
The date and time that the snapshot was created in the Control Plane API
The date and time on which this snapshot will be automatically deleted.
The size of the snapshot in GB.
The id of the cluster assigned to the gvc in this location.
curl --request PATCH \
--url https://api.cpln.io/org/{org}/gvc/{gvc}/volumeset/{name} \
--header 'Content-Type: application/json' \
--data '{
"$drop": [
"description"
],
"description": "<string>",
"tags": {},
"$replace/tags": {},
"spec": {
"$drop": [
"initialCapacity"
],
"initialCapacity": 123,
"performanceClass": "general-purpose-ssd",
"storageClassSuffix": "<string>",
"fileSystemType": "ext4",
"snapshots": {
"$drop": [
"createFinalSnapshot"
],
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"$replace/snapshots": {
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"autoscaling": {
"$drop": [
"maxCapacity"
],
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"$replace/autoscaling": {
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"mountOptions": {
"$drop": [
"resources"
],
"resources": {
"$drop": [
"maxCpu"
],
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
},
"$replace/resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
},
"$replace/mountOptions": {
"resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
}
},
"$replace/spec": {
"initialCapacity": 123,
"performanceClass": "general-purpose-ssd",
"storageClassSuffix": "<string>",
"fileSystemType": "ext4",
"snapshots": {
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"autoscaling": {
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"mountOptions": {
"resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
}
},
"gvc": {},
"$replace/gvc": {}
}'{
"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": {
"initialCapacity": 123,
"performanceClass": "general-purpose-ssd",
"storageClassSuffix": "<string>",
"fileSystemType": "ext4",
"snapshots": {
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"autoscaling": {
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"mountOptions": {
"resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
}
},
"status": {
"parentId": "<string>",
"usedByWorkload": "<string>",
"workloadLinks": [
"<string>"
],
"bindingId": "<string>",
"locations": [
{
"name": "<string>",
"volumes": [
{
"lifecycle": "creating",
"storageDeviceId": "<string>",
"oldStorageDeviceIds": [
"<string>"
],
"resourceName": "<string>",
"index": 123,
"currentSize": 123,
"currentBytesUsed": 123,
"iops": 123,
"throughput": 123,
"driver": "<string>",
"volumeSnapshots": [
{
"name": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"expires": "2023-11-07T05:31:56Z",
"size": 123,
"tags": [
{}
]
}
],
"attributes": {},
"zone": "<string>"
}
],
"desiredVolumeCount": 123,
"clusterId": "<string>"
}
]
},
"gvc": {}
}