Which interface can I use?
This reference describes the RustSC customer API for open beta. You need an existing RustSC account to sign in through the portal and use a browser session. Use an API key only with routes that say they accept one.
Send API requests to the RustSC address where you sign in.
Where supplied, the OpenAPI operation lists its permission (x-rustsc-permission), rate class (x-rustsc-rate-class) and cost class (x-rustsc-cost-class).
Sign in and discover your workspace
Every unsafe cookie-authenticated request needs X-CSRF-Token, including sign-in requests. A read-only permission does not permit creating resources, saving wipe plans or issuing credentials.
- Read GET /api/v1/session with a cookie-aware client. Keep its cookies and csrfToken private.
- Sign in through the portal. Use one of the options it shows, such as Discord, Google, Apple or a passkey already added to your account. The customer API has no password sign-in.
- Read GET /api/v1/session again after that sign-in, with the browser's cookies, to obtain the current session and request token.
- Read GET /api/v1/workspaces. Select a workspace returned for this account, then list that workspace's hosts and servers. Never infer IDs from names or use another workspace's IDs.
Synthetic request bodies
These are request bodies for the documented operations, not credentials or a ready-made customer session. Replace the sample values only in your own client.
POST /api/v1/workspaces
{"name":"Example community"}
POST /api/v1/workspaces/{workspaceId}/servers/{serverId}/actions/restart
Idempotency-Key: example-restart
{"force":false}
POST /api/v1/workspaces/{workspaceId}/servers/{serverId}/backups
Idempotency-Key: example-backup
{}
POST /api/v1/workspaces/{workspaceId}/servers/{serverId}/actions/plan-wipe
Idempotency-Key: example-wipe-plan
{"seed":12345,"worldSize":3500}Versions and compatibility
Use the v1 links when building a client. Ignore unknown response fields and treat unknown enum values as other. Read the operation's declared request and response schema before sending it.
Keep a copy of the contract used to build your client and compare it before upgrading.