# ControlPlane Org API

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

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

The Org API from ControlPlane — 13 operation(s) for org.

## Operations (15)

| Method | Path | Summary |
|---|---|---|
| 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} |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/controlplane/openapi/controlplane-org-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/controlplane/json-schema/controlplane-post-org-my-org-gvc-my-gvc-workload-workloadid-command-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/controlplane/json-schema/controlplane-post-org-my-org-gvc-my-gvc-volumeset-my-volume-set-command-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/controlplane/json-schema/controlplane-patch-org-org-agent-name-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/controlplane/json-schema/controlplane-post-org-org-agent-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/controlplane/json-schema/controlplane-get-quota-catalog-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/controlplane/json-schema/controlplane-post-org-my-org-quota-increase-requests-response-schema.json

## Other ControlPlane APIs (11)

- [ControlPlane About API](https://apis.io/apis/controlplane/controlplane-about-api/)
- [ControlPlane Artifacts API](https://apis.io/apis/controlplane/controlplane-artifacts-api/)
- [ControlPlane Audit API](https://apis.io/apis/controlplane/controlplane-audit-api/)
- [ControlPlane ControlPlane API](https://apis.io/apis/controlplane/controlplane-controlplane-api-api/)
- [ControlPlane Docker API](https://apis.io/apis/controlplane/controlplane-docker-api/)
- [ControlPlane Health API](https://apis.io/apis/controlplane/controlplane-health-api/)
- [ControlPlane Helm API](https://apis.io/apis/controlplane/controlplane-helm-api/)
- [ControlPlane Quota Catalog API](https://apis.io/apis/controlplane/controlplane-quota-catalog-api/)
- [ControlPlane Quota Increase Requests API](https://apis.io/apis/controlplane/controlplane-quota-increase-requests-api/)
- [ControlPlane Resources API](https://apis.io/apis/controlplane/controlplane-resources-api/)
- [ControlPlane Signups API](https://apis.io/apis/controlplane/controlplane-signups-api/)

## Tags

Org

---

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