ControlPlane

ControlPlane About API

The About API from ControlPlane — 1 operation(s) for about.

Documentation GitHub OpenAPI

Operations 1

GET /about GET /about #

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-about-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: ControlPlane About 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:
- url: https://api.cpln.io
security:
- apiKey: []
tags:
- name: About
paths:
  /about:
    get:
      operationId: get_about
      tags:
      - About
      summary: GET /about
      x-source: https://docs.controlplane.com/cli-reference/using-cli/troubleshooting
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -I https://api.cpln.io/about \n Check if you’re behind a proxy. \n  Output and display \n Output is truncated or incomplete Problem : Text output doesn’t show all data. Solutions : \n Use JSON or YAML output for complete data: \n cpln < comman d > --output json \n cpln < comman d > --output yaml \n Increase the max results: \n cpln < comman d > --max 100 \n Set --max 0 to get all the records. \n Use j"
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization