This API v3 documentation is currently still on progress. For any issue, please contact support@runcloud.io

Server Object

GET

/servers/{{serverId}}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

string

required

Example:

application/json

Body Params application/json

object {0}

Example

{}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://manage.runcloud.io/api/v3/servers/{{serverId}}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Responses

🟢200Success

application/json

Body

integer

required

Server ID

name

string

required

Server Name

provider

string

required

Server Provider

stack

string

required

Stack of the server whether native or containerized

ipAddress

string

required

IP Address of the server

country_iso_code

string

required

string

required

Operating system of the server

osVersion

string

required

Version of the OS

connected

boolean

required

Status of the server whether it's connected to RunCloud or not

online

boolean

required

Status of the server whether it's online or not

agentVersion

string

required

RunCloud agent version

phpCLIVersion

string

required

PHP CLI version

softwareUpdate

boolean

required

Auto software update

securityUpdate

boolean

required

Auto security update

transferStatus

string

required

Status on whether the server is transferrable or not

created_at

string

required

The time that the server was created at

tags

array[string]

required

Server tags

Example

{
    "id": 10101,
    "name": "server minions",
    "provider": "Akamai (Linode)",
    "stack": "nginx",
    "ipAddress": "2.2.2.2",
    "country_iso_code": "JP",
    "os": "Ubuntu",
    "osVersion": "focal",
    "connected": true,
    "online": true,
    "agentVersion": "2.8.7-1+ubuntu20.04+11",
    "phpCLIVersion": "php81rc",
    "softwareUpdate": false,
    "securityUpdate": true,
    "transferStatus": "AVAILABLE",
    "created_at": "2024-07-09 06:56:05",
    "tags": []
}

Modified at 2024-10-16 08:42:42

Create Server

Installation Script