API Documentation

A documentation for developer

Introduction

Get Started

To get started with API, you need a RunCloud account. If you don’t have one, you can create a new account here.

Once you have created the account, you can use API Key and API Secret that you can get from the profile menu to use our API.

API endpoint

The base URL for our API is

https://manage.runcloud.io/base-api/

All request to the API must be made over HTTPS.

All request and response will be in JSON formatted output.

Asynchronous

If you are creating any object from the API, the response you will get from POST request will not contain the object that you are creating since the process is asynchronous. If the process is not asynchronous, we will add the object that you have created inside response.

Sometimes you may found _links inside response data. This is due to our panel https://manage.runcloud.io is also using the same API. However, they are different in path. So, you may found the link start from /api instead of /base-api. If you want to use _link resources, you need to rewrite the /api to /base-api.