VPS

/vps-intance

GET

Returns a list of VPS Instances.

JSON request

uuid string Comma separated list of uuids to display (optional)

JSON response

Possible errors

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/vps-instance" | python -m json.tool

POST

Create new VPS instance of specified VPS Tier and using VPS Image

JSON request

tier string UUID representing VPS Tier instance. (Required)
image integer VPS Image id. (Required)
interval integer Instance registration period in months. (Optional, defaults value: 1)
is_auto_renew_enabled boolean Set to true to enable automatic renewals (and billing of them) by the system.

JSON response

object: VPS Instance

Possible errors

Sample

curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "tier": "17adc96a-e95c-4b3a-bab8-eb95e3144387",
        "image": 147,
        "interval: 1
    }
' \
"{{api_base_url}}/vps-instance" | python -m json.tool

/vps-instance/{id}

GET

Get detailed information about VPS Instance

Query parameters

embed string Extend output with extra details. Possible option: tier, adds tier details.

JSON response

object: VPS Instance

Possible errors

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/vps-instance/{id}" | python -m json.tool

PUT

Update VPS Instance information.

JSON request

tier string UUID representing VPS Tier instance.
is_suspended boolean Suspend/Unsuspend instance.
is_auto_renew_enabled boolean Enable or disable automatic renewals for this domain.
reverse_dns array
ip_address string ip address which will be added to PTR record
hostname string hostname which will be added to PTR record

JSON response

object: VPS Instance

Possible errors

Sample

curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "tier": "17adc96a-e95c-4b3a-bab8-eb95e3144387",
        "is_suspended": true
    }
' \
"{{api_base_url}}/vps-instance/{id}" | python -m json.tool

DELETE

Delete VPS instance.

Possible errors

Sample

curl \
--request DELETE \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/vps-instance/{id}" | python -m json.tool