API Reference

Build on the Substrate API

A complete REST API with 150+ endpoints for managing clusters, deployments, secrets, and every aspect of your cloud infrastructure programmatically.

Getting Started

Authentication

All API requests require a Bearer token in the Authorization header. Generate an API token from your account settings in the dashboard.

Base URL

https://api.substratecore.com/v1

Authentication header

Authorization: Bearer sk_live_your_api_token_here

Example request

curl -X GET https://api.substratecore.com/v1/clusters \
  -H "Authorization: Bearer sk_live_your_api_token" \
  -H "Content-Type: application/json"

Example response

{
  "data": [
    {
      "id": "cls_abc123",
      "name": "prod-us-east",
      "provider": "eks",
      "region": "us-east-1",
      "status": "running",
      "nodes": 5,
      "created_at": "2025-12-01T10:00:00Z"
    }
  ],
  "meta": { "total": 1, "page": 1, "per_page": 20 }
}

Endpoints

API categories

The Substrate API is organized into logical resource categories. Every action available in the dashboard is also available via the API.

Clusters

18 endpoints

Provision, register, list, update, and delete clusters.

Deployments

14 endpoints

Create, scale, restart, and monitor deployments.

Services

8 endpoints

Manage Kubernetes services and load balancers.

Templates

10 endpoints

CRUD operations for reusable deployment templates.

Secrets

12 endpoints

Encrypted secrets management with rotation support.

Domains

6 endpoints

Custom domain configuration and SSL certificates.

Projects

9 endpoints

Project-level resource organization and access.

Integrations

15 endpoints

Git providers, registries, and log sinks.

Billing

8 endpoints

Usage, invoices, and cost breakdowns.

Audit

5 endpoints

Query and export audit trail events.

Rate limiting

API requests are rate limited to ensure fair usage across all accounts. Rate limit headers are included in every response.

1,000

Requests / minute

50,000

Requests / hour

Custom

Enterprise plans

Start building with the API

Create your free account to get an API token and start integrating Substrate into your workflows.

Start free