API Documentation

A documentation for developer

Settings

PATCH Server details

HTTP Request

PATCH https://manage.runcloud.io/base-api/servers/<server.id>/settings/meta

Arguments

Parameters Required Description
serverName YES Name of the server
serverProvider NO Name of the company that provides your server

Request

curl -X PATCH "https://manage.runcloud.io/base-api/servers/yO4VAbX2BkNz/settings/meta" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    --data '{
        "serverName": "RunCloudDev",
        "serverProvider": "Custom Server Sdn. Bhd."
    }'

Response

{
    "message": "Successfully updated server details",
    "resetForm": false
}

PATCH SSH config

HTTP Request

PATCH https://manage.runcloud.io/base-api/servers/<server.id>/settings/ssh

Arguments

Parameters Required Description
passwordlessLogin YES Send true of false
useDns YES Send true or false
preventRootLogin YES Send true or false

Request

curl -X PATCH "https://manage.runcloud.io/base-api/servers/yO4VAbX2BkNz/settings/ssh" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    --data '{
        "passwordlessLogin": true,
        "useDns": false,
        "preventRootLogin": true
    }'

Response

{
    "message": "Successfully updated SSH Configuration",
    "resetForm": false
}

PATCH Software update

HTTP Request

PATCH https://manage.runcloud.io/base-api/servers/<server.id>/settings/autoupdate

Arguments

Parameters Required Description
autoUpdate YES Send true or false
autoUpdateSecurity YES Send true or false

Request

curl -X PATCH "https://manage.runcloud.io/base-api/servers/yO4VAbX2BkNz/settings/autoupdate" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    --data '{
        "autoUpdate": false,
        "autoUpdateSecurity": true
    }'

Response

{
    "message": "Successfully updated auto update settings",
    "resetForm": false
}