ControlPlane

ControlPlane API

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

GitHub OpenAPI

Operations 28

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 #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/openapi/_ae-authored/controlplane-openapi-generated.yml

Schemas & Data

📊
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

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/controlplane:controlplane-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

controlplane-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: ControlPlane API
  version: '2026-10-10'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-10: 28 operation(s) read from 29 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; ControlPlane has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 27
    documentation: 1
    pages-with-code: 23
    pages-read: 29
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-10'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.controlplane.com/reference/agent
  - https://docs.controlplane.com/reference/domain
  - https://docs.controlplane.com/api-reference/api
  - https://docs.controlplane.com/reference/auditctx
  - https://docs.controlplane.com/reference/workload
  - https://docs.controlplane.com/reference/volumeset
  - https://docs.controlplane.com/reference/deployment
  - https://docs.controlplane.com/reference/workload/types
  - https://docs.controlplane.com/reference/workload/general
  - https://docs.controlplane.com/cli-reference/installation
  - https://docs.controlplane.com/cli-reference/get-started/images
  - https://docs.controlplane.com/api-reference/agent/get-all-agents
  - https://docs.controlplane.com/api-reference/agent/create-an-agent
  - https://docs.controlplane.com/api-reference/agent/query-agent-health
  - https://docs.controlplane.com/cli-reference/using-cli/troubleshooting
  - https://docs.controlplane.com/api-reference/agent/get-an-agent-by-name
  - https://docs.controlplane.com/api-reference/agent/delete-an-agent-by-name
  - https://docs.controlplane.com/api-reference/agent/get-all-agents-based-on-a-query
  - https://docs.controlplane.com/api-reference/agent/perform-a-patch-on-an-agent-by-name
  - https://docs.controlplane.com/api-reference/agent/get-available-permissions-for-an-agent
  - https://docs.controlplane.com/api-reference/agent/get-the-access-report-for-an-agent-by-name
  - https://docs.controlplane.com/guides/cpln-delete
  - https://docs.controlplane.com/template-catalog/templates/clickhouse
  - https://docs.controlplane.com/quickstart/observe-workload
  - https://docs.controlplane.com/quickstart/connect-workloads
  - https://docs.controlplane.com/guides/cli/workload/run
  - https://docs.controlplane.com/guides/cli/cpln-operator
  - https://docs.controlplane.com/guides/manage-quotas
  - https://docs.controlplane.com/guides/compose-deploy
servers:


# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/controlplane/refs/heads/main/openapi/_ae-authored/controlplane-openapi-generated.yml