# ControlPlane API

**Canonical:** https://apis.io/apis/controlplane/controlplane-api/  
**Provider:** ControlPlane — https://apis.io/providers/controlplane/  
**Base URL:** https://api.cpln.io  
**Documentation:** https://docs.controlplane.com/reference/agent

ControlPlane API is published by [ControlPlane](https://apis.io/providers/controlplane/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

ControlPlane API as documented publicly: 28 operations. Contract generated from the documentation by API Evangelist (2026-10-10); not the provider's own document.

## Operations (28)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | GET / |
| GET | `/about` | GET /about |
| GET | `/artifacts.cpln-build.appspot.com/binaries/cpln/2921851532-6959edea/{29218515326959edeaId}` | GET /artifacts.cpln-build.appspot.com/binaries/cpln/2921851532-6959edea/cpln-linux.tgz |
| POST | `/audit/org` | POST /audit/org |
| GET | `/docker/buildx/releases/download/v0.29.1/buildx-v0.29.1.linux-amd64` | GET /docker/buildx/releases/download/v0.29.1/buildx-v0.29.1.linux-amd64 |
| GET | `/health` | GET /health |
| GET | `/helm/helm/main/scripts/get-helm-3` | GET /helm/helm/main/scripts/get-helm-3 |
| POST | `/org/my-org/gvc/my-gvc/volumeset/my-volume-set/-command` | To issue a command, send a POST to the volume set’s -command endpoint. |
| GET | `/org/my-org/gvc/my-gvc/workload/-deployment` | Deployment - Control Plane Documentation |
| GET | `/org/my-org/gvc/my-gvc/workload/my-app/deployment` | Deployment - Control Plane Documentation |
| GET | `/org/my-org/gvc/my-gvc/workload/my-app/deployment/aws-eu-central-1` | Deployment - Control Plane Documentation |
| POST | `/org/my-org/gvc/my-gvc/workload/{workloadid}/-command` | Cron workloads can be run on-demand even when they are suspended. |
| POST | `/org/my-org/quota-increase-requests` | POST /org/my-org/quota-increase-requests |
| GET | `/org/my-org/quotas` | GET /org/my-org/quotas |
| GET | `/org/{org}/agent` | GET /org/{org}/agent |
| POST | `/org/{org}/agent` | POST /org/{org}/agent |
| POST | `/org/{org}/agent/-query` | POST /org/{org}/agent/-query |
| GET | `/org/{org}/agent/-schema/permissions` | GET /org/{org}/agent/-schema/permissions |
| DELETE | `/org/{org}/agent/{name}` | DELETE /org/{org}/agent/{name} |
| PATCH | `/org/{org}/agent/{name}` | PATCH /org/{org}/agent/{name} |
| GET | `/org/{org}/agent/{name}/{id}` | GET /org/{org}/agent/{name}/-accessreport |
| GET | `/org/{org}/{id}/{name}` | GET /org/{org}/agent/{name} |
| GET | `/quota-increase-requests` | GET /quota-increase-requests |
| GET | `/quota-increase-requests/a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c` | GET /quota-increase-requests/a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c |
| GET | `/quota_catalog` | GET /quota_catalog |
| GET | `/resources.yaml` | GET /resources.yaml |
| GET | `/signups` | Observe your workload |
| POST | `/signups` | Observe your workload |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/openapi/_ae-authored/controlplane-openapi-generated.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/json-schema/controlplane-post-org-my-org-gvc-my-gvc-workload-workloadid-command-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/json-schema/controlplane-post-org-my-org-gvc-my-gvc-volumeset-my-volume-set-command-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/json-schema/controlplane-patch-org-org-agent-name-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/json-schema/controlplane-post-org-org-agent-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/json-schema/controlplane-get-quota-catalog-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/json-schema/controlplane-post-org-my-org-quota-increase-requests-response-schema.json
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/controlplane/controlplane-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/controlplane/.