Skip to content

Servers

Connect New Server

This api request includes two actions 'create and install'. First, we need to post create request then post-install request. Parameters for both actions are the same.

Create New Server

Parameters

Variable Necessitty Type Description
name REQUIRED string Name of the server
ip4 REQUIRED string Public IP Address of the server
provider REQUIRED string Provider of server
root_password OPTIONAL string server root password

HTTP REQUEST

POST https://api.cloudstick.io/api/v1/servers/users/<user_id>?action=create

REQUEST

curl --request POST \
  --url 'https://api.cloudstick.io/api/v1/servers/users/{user_id}?action=create&api_key={api-key}&api_secret={secret-key}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name":"my_server_name",
    "ip4":"127.0.0.1",
    "provider":"my_provider",
    "root_password":"password"
}'

RESPONCE

{
  "id": 011,
  "uuid": "ODBmZmYyMjMtYjUyNy00ODE4LWJhMzMtMTA1OWMxM2U2ZGNl",
  "created_at": "2021-08-28T05:39:14.603637978Z",
  "name": "my_server_name",
  "user_id": 001,
  "provider": "my_provider",
  "ip4": "127.0.0.1",
  "php_cli_version": 80,
  "root_password": "password",
  "remote_mysql_access": {
    "Bool": false,
    "Valid": false
  },
  "connected": {
    "Bool": false,
    "Valid": false
  },
  "quota_enabled": {
    "Bool": false,
    "Valid": false
  },
  "reboot_requested": false,
  "rebooted": false,
  "host_name": "",
  "is_available": false,
  "is_accessible": false,
  "is_shared": false
}

Install New Server

Parameters

Variable Necessisty Type Description
name REQUIRED string Name of the server
ip4 REQUIRED string Public IP Address of the server
provider REQUIRED string Provider of server
root_password OPTIONAL string server root password

HTTP REQUEST

POST https://api.cloudstick.io/api/v1/servers/users/<user_id>?action=install

REQUEST

curl --request POST \
  --url 'https://api.cloudstick.io/api/v1/servers/users/{user_id}?action=install&api_key={api-key}&api_secret={secret-key}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name":"my_server_name",
    "ip4":"127.0.0.1",
    "provider":"my_provider",
    "root_password":"password"
}'

RESPONCE

{
  "id": 011,
  "uuid": "ODBmZmYyMjMtYjUyNy00ODE4LWJhMzMtMTA1OWMxM2U2ZGNl",
  "created_at": "2021-08-28T05:39:14.603637978Z",
  "name": "my_server_name",
  "user_id": 001,
  "provider": "my_provider",
  "ip4": "127.0.0.1",
  "php_cli_version": 80,
  "root_password": "password",
  "remote_mysql_access": {
    "Bool": false,
    "Valid": false
  },
  "connected": {
    "Bool": false,
    "Valid": false
  },
  "quota_enabled": {
    "Bool": false,
    "Valid": false
  },
  "reboot_requested": false,
  "rebooted": false,
  "host_name": "",
  "is_available": false,
  "is_accessible": false,
  "is_shared": false
}