​
API Overview

The Ctrlplane API enables programmatic access to all platform functionality, allowing you to automate deployments, manage resources, and integrate with your existing tools.

​
API Structure

Our API follows OpenAPI standards (formerly Swagger) with these key features:

  • RESTful Design: Resource-based endpoints with standard HTTP methods
  • JSON Payloads: Consistent request/response format
  • Key Authentication: Simple API key authentication
  • Comprehensive Endpoints: Complete coverage of platform functionality

​
Documentation Structure

The API documentation includes:

  • HTTP methods (GET, POST, PUT, DELETE)
  • Required and optional parameters
  • Request/response schemas with examples
  • Authentication requirements
  • Status codes and error handling

View the complete OpenAPI specification on GitHub.