API Documentation

A documentation for developer

Authentication

Table of Contents:

Authentication

We are using Basic Authentication for Authentication

For every request made to RunCloud API, you need to supply API Key and API Secret as Basic Authentication.

You can get API Key and API Secret inside your Settings > API Key.

Summary page example

Once you have got your API Key and Secret, you can test the authentication by sending GET request to /ping endpoint

Request

curl -X GET "https://manage.runcloud.io/base-api/ping" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

If your request is successful, you will get pong message as the output.

Response

{
    "message": "pong"
}