Official opeNode API documentation.

Note that our CLI uses this API in a convenient manner.

The API token must be provided using the following HTTP header: x-auth-token: YOUR_TOKEN.


Requests through the API are rate limited per user token.

  • 250 Requests per minute

Some headers are set on responses:

  • X-RateLimit-Remaining
  • X-RateLimit-Limit
  • X-RateLimit-Remaining

Resources

Account

Resource Description
GET /account/me
GET /account/spendings

Addons

Resource Description
GET /global/addons

Available locations

Resource Description
GET /global/available-locations
GET /global/available-locations/:str_id/ips

Collaborators

Resource Description
GET /instances/:site_name/collaborators
POST /instances/:site_name/collaborators
PATCH /instances/:site_name/collaborators/:id
DELETE /instances/:site_name/collaborators/:id

Configs

Resource Description
GET /instances/:site_name/get-config
POST /instances/:site_name/set-config
POST /instances/:id/configs

Dns

Resource Description
GET /instances/:site_name/dns

Env variables

Resource Description
GET /instances/:id/env_variables
PUT /instances/:id/env_variables
POST /instances/:id/env_variables
POST /instances/:id/env_variables/:name
DELETE /instances/:id/env_variables/:name

Events

Resource Description
GET /instances/:site_name/events
GET /instances/:site_name/events/:id

Executions

Resource Description
GET /instances/:id/executions/list/:type
GET /instances/:site_name/executions/:id

Global

Resource Description
GET
GET /global/test
GET /global/version
GET /global/status/job-queues
GET /global/available-plans
GET /global/available-plans-at/:type/:location_str_id
GET /global/available-configs
GET /global/services
GET /global/stats
GET /global/services/down
GET /global/settings
GET /global/type-lists/:type

Instance stat

Resource Description
GET /instances/:id/stats
GET /instances/:id/stats/mem_cpu
GET /instances/:site_name/stats/spendings
GET /instances/:site_name/stats/network

Instances

Resource Description
GET /instances
GET /instances/summary
GET /instances/:id/summary
GET /instances/:site_name/status
GET /instances/:id/routes
POST /instances/create
DELETE /instances/:site_name
PATCH /instances/:site_name
POST /instances/:id/crontab
GET /instances/:site_name/plan
GET /instances/:site_name/plans
POST /instances/:site_name/set-plan
POST /instances/:site_name/changes
POST /instances/:id/cmd
POST /instances/:site_name/stop
POST /instances/:site_name/erase-all
GET /instances/:site_name/logs
POST /instances/:id/scm-clone
POST /instances/:id/restart
POST /instances/:site_name/reload
POST /instances/:id/prepare-one-click-app
PATCH /instances/:id/one-click-app

Locations

Resource Description
GET /instances/:site_name/locations
POST /instances/:id/add-location
POST /instances/:id/remove-location

My addons

Resource Description
GET /instances/:sitename/addons
GET /instances/:sitename/addons/:id
POST /instances/:sitename/addons
PATCH /instances/:sitename/addons/:id
DELETE /instances/:sitename/addons/:id
POST /instances/:sitename/addons/:id/offline

Notifications

Resource Description
POST /notifications

Open source

Resource Description
GET /open_source_projects/latest

Snapshots

Resource Description
GET /instances/:site_name/snapshots
GET /instances/:site_name/snapshots/:id
POST /instances/:id/snapshots

Storage areas

Resource Description
GET /instances/:site_name/storage-areas
POST /instances/:site_name/add-storage-area
POST /instances/:site_name/del-storage-area

Storages

Resource Description
POST /instances/:site_name/increase-storage
POST /instances/:site_name/destroy-storage
GET /instances/:site_name/storage

User notifications

Resource Description
GET /notifications