Quickstart

You’ll create a token, ask the API who it thinks you are, then list your cloud servers.

Create a token

In the client area, open Settings → API tokens and create one. Give it a name you’ll recognise later, and tick services:read. That’s all this walkthrough needs.Copy the token straight away. It’s shown once and we only keep a hash, so if you lose it you revoke it and make another.Put it in an environment variable rather than pasting it into commands:

export SE_TOKEN="se_live_..."

Check the token

GET /v1/auth/whoami accepts any valid token, whatever its scopes. It tells you who the credential belongs to and what it may do:

curl https://my.server.express/api/v1/auth/whoami \
  -H "Authorization: Bearer $SE_TOKEN"

{
  "success": true,
  "data": {
    "id": "cm1x...",
    "email": "[email protected]",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "role": "client",
    "emailVerified": true,
    "credential": "api_token",
    "tokenName": "Quickstart",
    "scopes": ["services:read"],
    "admin": false
  }
}

If scopes isn’t what you expected, fix it now. Scopes are fixed when a token is created, so widening one means making a new token.

List your cloud servers

curl https://my.server.express/api/v1/cloud \
  -H "Authorization: Bearer $SE_TOKEN"

You get your cloud services, newest first. Use /v1/dedicated for dedicated servers. Both need services:read.

Read the envelope

Every response has the same outer shape, success or failure:

{ "success": true, "data": [] }

{ "success": false, "error": "This token is missing the \"services:power\" scope." }

Check success first, then read data. On failure, error is a sentence written for a person. Log it or show it, but don’t branch on its wording. Branch on the HTTP status instead. Errors and rate limits lists every status code.

Next steps

Pick your scopes

What each of the 14 scopes grants, and which ones can spend money or destroy data.

Drive your servers

Power, rescue, snapshots, reinstall and cancellation.

Get started

Guides

Next steps

Pick your scopes

Drive your servers

​Next steps

Pick your scopes

Drive your servers

Next steps