RedSwitches API
The RedSwitches API lets your own tools read your account, order instant servers from your account credit, and manage and power the servers you have. It is a plain JSON API over HTTPS.
What you can do
- Read your account, servers, traffic, orders, invoices, saved SSH keys and the instant servers on offer.
- Order an instant server, paid from your account credit, with a dry run that shows the exact total first.
- Rename servers, request reverse DNS, and add or remove saved SSH keys.
- Power servers on, off and reboot them, and follow each action until it is done.
The basics
| Base URL | https://api.redswitches.com/v1. GET https://api.redswitches.com/ returns a small JSON index. |
| Docs | https://api.redswitches.com/docs/ |
| Format | JSON in, JSON out. Times are UTC in ISO 8601 (2026-11-15T09:30:00Z). |
| Authentication | Authorization: Bearer <key>. See Authentication and keys. |
| Ids | Typed strings: srv_123 (server), ord_456 (order), inv_789 (invoice), ofr_12 (offer), sshkey_7 (SSH key), act_42 (action). |
| Money | Decimal strings such as "129.00", except order totals, which are minor units such as "12900". |
| Writes | Every POST and DELETE needs an Idempotency-Key header. See Idempotency and retries. |
A first request:
curl -sS https://api.redswitches.com/v1/auth/verify \
-H "Authorization: Bearer $REDSWITCHES_API_KEY"
{
"id": "key_5",
"label": "monitoring",
"hint": "a1B2",
"env": "live",
"permissions": ["read"],
"effective_permissions": ["read"],
"expires_at": "2027-02-13T09:30:00Z"
}
Where to go next
- Quickstart: turn on API access, create a key, make your first call.
- Authentication and keys: permissions, server lists, expiry and revocation.
- Idempotency and retries: how to repeat a write safely.
- Rate limits and errors: every error code and what to do about it.
- Ordering guide and Power and actions guide.
- Resources: Account, Offers, Servers, Reverse DNS, Orders, Invoices, SSH keys, Actions and power, Cancellation, Reinstall, Rescue.
- API reference: every endpoint and field, built from the OpenAPI file.
- Tools: Terraform, CLI, MCP for agents.
- Changelog.
SDKs and tools
The examples show curl and the official SDKs:
| Language | Package | Entry point |
|---|---|---|
| TypeScript | @redswitches/api | new RedSwitches({ apiKey }) |
| Python | redswitches | Client(api_key=...) |
| Go | github.com/redswitches/redswitches-go | redswitches.NewClient(key) |
For agents
A plain-text index is at llms.txt, and every page has a Markdown twin under md/ (this page is md/index.md).