Skip to main content
1

Generate your API Key

In the Dashboard, open “Your Account”, go to Developer and click Generate New API Key. Copy it right away: you cannot see it again. See Authentication.
2

Check that it works

GET /v1/users/@me returns your account. A 401 means the key is wrong, see Authentication errors.
3

List your applications

Each application has an _id, which you use in the other endpoints, and currentResourceMetrics.online, which tells if it is running. See GET /v1/apps.
4

Start, stop or restart one

Use the _id of the application. Starting one that is already running returns 500, so check online first.
The same works for stop and restart.
5

Follow its logs

GET /v1/apps/{appId}/logs streams the console of the application while it runs.

The same thing in code

When something does not work

Read Why an application stopped. The cause is in the shutdownNotice and suspension fields of the application, and in the message the dashboard shows when you open it.
You went over a rate limit. Wait the number of seconds in the Retry-After header.
The owner of the application does not have an active plan, or you do not have the team permission the endpoint needs. See Teams and permissions.

Next steps

API reference

Base URL, errors, pagination and every endpoint.

JavaScript SDK

The same API as methods for Node.js.