API Reference

REST API

Everything you can do in the dashboard, you can do via the API.

Base URL

https://api.rackplane.io/v1

All requests must include an Authorization: Bearer <token> header. Generate API keys from Settings → API Keys.

Authentication

All API requests require a Bearer token in the Authorization header. Obtain tokens from the dashboard under Settings → API Keys.

POST /auth/login
POST /auth/register
POST /auth/refresh

Organizations

Manage organizations and team members.

GET /orgs
GET /orgs/{id}
PUT /orgs/{id}

Nodes

Manage the Linux servers connected to your organization.

GET /orgs/{orgId}/nodes
GET /nodes/{id}
DELETE /nodes/{id}
PUT /nodes/{id}/cost

Environments

Organize services and deployments into logical environments.

GET /orgs/{orgId}/environments
POST /orgs/{orgId}/environments
GET /environments/{id}
PUT /environments/{id}
DELETE /environments/{id}

Services

Define Docker container services to deploy across your nodes.

GET /orgs/{orgId}/services
POST /orgs/{orgId}/services
GET /services/{id}
PUT /services/{id}
DELETE /services/{id}

Deployments

Deploy services to specific nodes and manage releases.

GET /services/{serviceId}/deployments
POST /services/{serviceId}/deployments
POST /deployments/{id}/rollback
POST /deployments/{id}/restart

Virtual Machines

Manage QEMU/KVM virtual machines on your nodes.

GET /orgs/{orgId}/vms
POST /orgs/{orgId}/vms
GET /vms/{id}
POST /vms/{id}/start
POST /vms/{id}/stop
DELETE /vms/{id}

Game Servers

Host and manage game servers with the Egg system.

GET /orgs/{orgId}/game-servers
POST /orgs/{orgId}/game-servers
GET /game-servers/{id}
POST /game-servers/{id}/power
POST /game-servers/{id}/reinstall
DELETE /game-servers/{id}

Secrets

Manage encrypted secrets that are injected into services at runtime.

GET /orgs/{orgId}/secrets
POST /orgs/{orgId}/secrets
PUT /secrets/{id}
DELETE /secrets/{id}

Autoscale Rules

Configure automatic scaling based on resource metrics.

GET /orgs/{orgId}/autoscale
POST /orgs/{orgId}/autoscale
PUT /autoscale/{id}
DELETE /autoscale/{id}

Network Policies

Control inter-service communication with allow/deny rules.

GET /orgs/{orgId}/network-policies
POST /orgs/{orgId}/network-policies
PUT /network-policies/{id}
DELETE /network-policies/{id}

Webhooks

Receive HTTP callbacks for deployment events.

GET /orgs/{orgId}/webhooks
POST /orgs/{orgId}/webhooks
PUT /webhooks/{id}
DELETE /webhooks/{id}

Audit Log

Query the immutable audit trail of all actions.

GET /orgs/{orgId}/audit
GET /orgs/{orgId}/audit/export

Rate Limits

Starter: 100 requests/minute

Pro: 500 requests/minute

Enterprise: Custom limits

Rate limit headers are included in every response: X-RateLimit-Remaining and X-RateLimit-Reset.