Introduction

Our HTTP REST API allows you to manage vital details of your account and services in client portal. JSON is used for all API returns

Use left menu to browse trough available methods, use right menu to check required parameters, data to post and code samples in various languages.

Swagger Doc: You can download or display the JSON to generate documentation in Swagger.

Authentication

Basic Authentication

# pass the correct header with each request (-u option)
curl 'https://vservs.com/client-area/api/details' \
    -u "username:password"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$resp = $client->get('details');

# python requests module handles basic authentication if provided with auth parameter
payload = username
req = requests.get('https://vservs.com/client-area/api/details', auth=('username', 'password'))
print(req.json())

Make sure to replace username and password with your client area details.

This authentication method requires that you send your client area username (email address) and password with each request.

API calls that require authentication expect a header in the form of Authorization: Basic <credentials>, where credentials is the Base64 encoding of username and password joined by a single colon :.

For example:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

You can find more info on this authentication method here: Basic HTTP Authentication

Clientarea

Login

Generate new authorization token

POST_DATA="{
    \"username\": \"user@example.com\",
    \"password\": \"secret\"
}"

curl -X POST "https://vservs.com/client-area/api/login" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
]);

$options = [
    'json' => [
        "username" => "user@example.com",
        "password" => "secret"
    ]
]
$resp = $client->post('login', $options);
echo $resp->getBody();

payload = {
    'username': "user@example.com",
    'password': "secret"
}


req = requests.post('https://vservs.com/client-area/api/login', json=payload)
print(req.json())

Example Response:

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRw(...)5lZ9T79ft9uwOkqRRmIBbtR51_w",
    "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzMD(...)ChwIAb3zvxBu6kvULa2AwAt9U-I"
}

HTTP Request

POST /login

Query Parameters

Parameter	Type	Description
username	string	Your acount email address
password	string	Account password

Logout

Invalidate authorization token

curl -X POST "https://vservs.com/client-area/api/logout" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->post('logout');
echo $resp->getBody();

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/logout', auth=auth)
print(req.json())

Example Response:

{
    "status": true
}

HTTP Request

POST /logout

Refresh Token

Generate new authorization token using refresh token

POST_DATA="{
    \"refresh_token\": \"refresh_tokenValue\"
}"

curl -X POST "https://vservs.com/client-area/api/token" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
]);

$options = [
    'json' => [
        "refresh_token" => "refresh_tokenValue"
    ]
]
$resp = $client->post('token', $options);
echo $resp->getBody();

payload = {
    'refresh_token': "refresh_tokenValue"
}


req = requests.post('https://vservs.com/client-area/api/token', json=payload)
print(req.json())

Example Response:

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHR(...)vY2xlYiHGvauCWZD9B0VwXgHEzXDllqY",
    "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJBQ(...)Rmivc_u3YA_kgDqOPtUuGNXOzueXYtZw"
}

HTTP Request

POST /token

Query Parameters

Parameter	Type	Description
refresh_token	string	Refresh token previously obtained from POST /login

Revoke Token

Invalidate authorization and refresh token. Pass refresh token or call this method with valid access token

POST_DATA="{
    \"refresh_token\": \"refresh_tokenValue\"
}"

curl -X POST "https://vservs.com/client-area/api/revoke" \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
]);

$options = [
    'json' => [
        "refresh_token" => "refresh_tokenValue"
    ]
]
$resp = $client->post('revoke', $options);
echo $resp->getBody();

payload = {
    'refresh_token': "refresh_tokenValue"
}


req = requests.post('https://vservs.com/client-area/api/revoke', json=payload)
print(req.json())

Example Response:

{
    "status": true
}

HTTP Request

POST /revoke

Query Parameters

Parameter	Type	Description
refresh_token	string

User Details

Return registration details for my account

curl -X GET "https://vservs.com/client-area/api/details" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('details');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/details', auth=auth)
print(req.json())

Example Response:

{
    "client": {
        "id": "26",
        "email": "api@example.com",
        "lastlogin": "2016-12-30 12:24:28",
        "ip": "172.100.2.1",
        "host": "hostname",
        "firstname": "Joe",
        "lastname": "Doe",
        "companyname": "",
        "address1": "Pretty View Lane",
        "address2": "3294",
        "city": "Santa Rosa",
        "state": "California",
        "postcode": "95401",
        "country": "US",
        "phonenumber": "+1.24123123"
    }
}

HTTP Request

GET /details

Update User Details

Update registration details under my account

POST_DATA="{
    \"type\": \"typeValue\",
    \"companyname\": \"companynameValue\",
    \"businessregistrationnumber\": \"businessregistrationnumberValue\",
    \"vateu\": \"vateuValue\",
    \"firstname\": \"firstnameValue\",
    \"lastname\": \"lastnameValue\",
    \"email\": \"emailValue\",
    \"address1\": \"address1Value\",
    \"address2\": \"address2Value\",
    \"city\": \"cityValue\",
    \"state\": \"stateValue\",
    \"postcode\": \"postcodeValue\",
    \"country\": \"countryValue\",
    \"phonenumber\": \"phonenumberValue\"
}"

curl -X PUT "https://vservs.com/client-area/api/details" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "type" => "typeValue",
        "companyname" => "companynameValue",
        "businessregistrationnumber" => "businessregistrationnumberValue",
        "vateu" => "vateuValue",
        "firstname" => "firstnameValue",
        "lastname" => "lastnameValue",
        "email" => "emailValue",
        "address1" => "address1Value",
        "address2" => "address2Value",
        "city" => "cityValue",
        "state" => "stateValue",
        "postcode" => "postcodeValue",
        "country" => "countryValue",
        "phonenumber" => "phonenumberValue"
    ]
]
$resp = $client->put('details', $options);
echo $resp->getBody();

payload = {
    'type': "typeValue",
    'companyname': "companynameValue",
    'businessregistrationnumber': "businessregistrationnumberValue",
    'vateu': "vateuValue",
    'firstname': "firstnameValue",
    'lastname': "lastnameValue",
    'email': "emailValue",
    'address1': "address1Value",
    'address2': "address2Value",
    'city': "cityValue",
    'state': "stateValue",
    'postcode': "postcodeValue",
    'country': "countryValue",
    'phonenumber': "phonenumberValue"
}

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/details', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "client": {
        "id": "26",
        "email": "api@example.com",
        "lastlogin": "2016-12-30 12:34:20",
        "ip": "172.100.2.1",
        "host": "hostname",
        "firstname": "Joe",
        "lastname": "Doe",
        "companyname": "",
        "address1": "Pretty View Lane",
        "address2": "3194",
        "city": "Santa Rosa",
        "state": "California",
        "postcode": "95401",
        "country": "US",
        "phonenumber": "+1.24123123"
    },
    "info": [
        "client_info_updated"
    ]
}

HTTP Request

PUT /details

Query Parameters

Parameter	Type	Description
type	string	Account Type Available values: Private, Company.
companyname	string	Organization
businessregistrationnumber	string	Business registration number
vateu	string	VAT EU - If you have valid VAT-EU registered number please provide it here
firstname	string	First Name
lastname	string	Last Name
email	string	Email Address
address1	string	Address 1
address2	string	Address 2
city	string	City
state	string	State
postcode	string	Post code - Example 1000AB do not use spaces like 1000 AB
country	string	Country
phonenumber	string	Phone

User Logs

Returns logs from history

curl -X GET "https://vservs.com/client-area/api/logs" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('logs');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/logs', auth=auth)
print(req.json())

HTTP Request

GET /logs

Get Affiliate summary

curl -X GET "https://vservs.com/client-area/api/affiliates/summary" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('affiliates/summary');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/affiliates/summary', auth=auth)
print(req.json())

HTTP Request

GET /affiliates/summary

Get Affiliate campaigns

curl -X GET "https://vservs.com/client-area/api/affiliates/campaigns" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('affiliates/campaigns');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/affiliates/campaigns', auth=auth)
print(req.json())

HTTP Request

GET /affiliates/campaigns

Get Affiliate commissions

curl -X GET "https://vservs.com/client-area/api/affiliates/commissions" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('affiliates/commissions');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/affiliates/commissions', auth=auth)
print(req.json())

HTTP Request

GET /affiliates/commissions

Get Affiliate payouts

curl -X GET "https://vservs.com/client-area/api/affiliates/payouts" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('affiliates/payouts');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/affiliates/payouts', auth=auth)
print(req.json())

HTTP Request

GET /affiliates/payouts

Get Affiliate vouchers

curl -X GET "https://vservs.com/client-area/api/affiliates/vouchers" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('affiliates/vouchers');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/affiliates/vouchers', auth=auth)
print(req.json())

HTTP Request

GET /affiliates/vouchers

Get Affiliate commission plans

curl -X GET "https://vservs.com/client-area/api/affiliates/commissionplans" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('affiliates/commissionplans');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/affiliates/commissionplans', auth=auth)
print(req.json())

HTTP Request

GET /affiliates/commissionplans

List contacts

Return a list of contacts on this account

curl -X GET "https://vservs.com/client-area/api/contact" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('contact');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/contact', auth=auth)
print(req.json())

Example Response:

{
    "contacts": [
        {
            "email": "mary@example.com",
            "id": "49",
            "firstname": "Mary",
            "lastname": "Sue",
            "companyname": "",
            "company": "0",
            "lastlogin": "0000-00-00 00:00:00"
        }
    ]
}

HTTP Request

GET /contact

Add contact

Create new contact account, if password is provided you can use provided email addres to login as that contact.

POST_DATA="{
    \"password\": \"passwordValue\",
    \"privileges\": \"privilegesValue\",
    \"type\": \"typeValue\",
    \"companyname\": \"companynameValue\",
    \"businessregistrationnumber\": \"businessregistrationnumberValue\",
    \"vateu\": \"vateuValue\",
    \"firstname\": \"firstnameValue\",
    \"lastname\": \"lastnameValue\",
    \"email\": \"emailValue\",
    \"address1\": \"address1Value\",
    \"address2\": \"address2Value\",
    \"city\": \"cityValue\",
    \"state\": \"stateValue\",
    \"postcode\": \"postcodeValue\",
    \"country\": \"countryValue\",
    \"phonenumber\": \"phonenumberValue\"
}"

curl -X POST "https://vservs.com/client-area/api/contact" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "password" => "passwordValue",
        "privileges" => "privilegesValue",
        "type" => "typeValue",
        "companyname" => "companynameValue",
        "businessregistrationnumber" => "businessregistrationnumberValue",
        "vateu" => "vateuValue",
        "firstname" => "firstnameValue",
        "lastname" => "lastnameValue",
        "email" => "emailValue",
        "address1" => "address1Value",
        "address2" => "address2Value",
        "city" => "cityValue",
        "state" => "stateValue",
        "postcode" => "postcodeValue",
        "country" => "countryValue",
        "phonenumber" => "phonenumberValue"
    ]
]
$resp = $client->post('contact', $options);
echo $resp->getBody();

payload = {
    'password': "passwordValue",
    'privileges': "privilegesValue",
    'type': "typeValue",
    'companyname': "companynameValue",
    'businessregistrationnumber': "businessregistrationnumberValue",
    'vateu': "vateuValue",
    'firstname': "firstnameValue",
    'lastname': "lastnameValue",
    'email': "emailValue",
    'address1': "address1Value",
    'address2': "address2Value",
    'city': "cityValue",
    'state': "stateValue",
    'postcode': "postcodeValue",
    'country': "countryValue",
    'phonenumber': "phonenumberValue"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/contact', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "contact_id": "1",        
    "info": [
        "profile_added"
    ]
}

HTTP Request

POST /contact

Query Parameters

Parameter	Type	Description
password	string	Optional, allows you to login as contact
privileges	array	Array with privileges that you want to enable. Formatted the same way as output from GET /contact/privileges
type	string	Account Type Available values: Private, Company.
companyname	string	Organization
businessregistrationnumber	string	Business registration number
vateu	string	VAT EU - If you have valid VAT-EU registered number please provide it here
firstname	string	First Name
lastname	string	Last Name
email	string	Email Address
address1	string	Address 1
address2	string	Address 2
city	string	City
state	string	State
postcode	string	Post code - Example 1000AB do not use spaces like 1000 AB
country	string	Country
phonenumber	string	Phone

Contact privileges

List possible contact privileges. Each domain and service may list additional privileges, depending on available features.

curl -X GET "https://vservs.com/client-area/api/contact/privileges" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('contact/privileges');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/contact/privileges', auth=auth)
print(req.json())

Example Response:

{
    "privileges": {
        "billing": [
            "emails", // Receive billing notifications
            "payinvoice", // Allow to view/pay invoices
            "orders", // Allow to place new orders
            "balance", // View account balance
            "addfunds", // Add account funds
            "creditcard" // Edit Credit Card details
        ],
        "support": [
            "newticket", // Open new tickets
            "tickets", // View all tickets
            "closeticket", // Close tickets
            "emails" // Receive email notifications from support
        ],
        "misc": [
            "editmain", // Modify main profile details
            "emails", // View emails history
            "editipaccess", // Edit allowed IP access
            "manageprofiles", // Add / Edit contacts
            "affiliates" // Access affiliates section
        ],
        "services": {
            "full": 1, // Full control over services
            "332": [
                "basic", // View basic details
                "billing", // View billing info
                "cancelation", // Request cancellation
                "upgrade", // Upgrade / Downgrade
                "notify", // Receive related email notifications  
                (...)
                "logindetails"
            ]
        },
        "domains": {
            "full": 1, // Full control over domains
            "523": [
                "basic", // View basic details
                "renew", // Renew domain
                "notify", // Receive related email notifications  
                "contactinfo", // Contact Information
                (...)
                "nameservers" // Manage Nameservers
            ]
        }
    }
}

HTTP Request

GET /contact/privileges

Get contacts details

Return array with contact details

curl -X GET "https://vservs.com/client-area/api/contact/@id" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('contact/@id');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/contact/@id', auth=auth)
print(req.json())

Example Response:

{
    "contact": {
        "id": "49",
        "email": "mary@example.com",
        "firstname": "Mary",
        "lastname": "Sue",
        "companyname": "",
        "address1": "Pretty View Lane",
        "address2": "3194",
        "city": "Santa Rosa",
        "state": "California",
        "postcode": "95401",
        "country": "US",
        "phonenumber": "+1.24123123",
        "type": "Private",
        "privileges" : {
            "support" : ["tickets", "newticket"]
        }
    }
}

HTTP Request

GET /contact/@id

Query Parameters

Parameter	Type	Description
id	int	Contact ID

Edit contact

Change contact details`

POST_DATA="{
    \"privileges\": \"privilegesValue\",
    \"type\": \"typeValue\",
    \"companyname\": \"companynameValue\",
    \"businessregistrationnumber\": \"businessregistrationnumberValue\",
    \"vateu\": \"vateuValue\",
    \"firstname\": \"firstnameValue\",
    \"lastname\": \"lastnameValue\",
    \"email\": \"emailValue\",
    \"address1\": \"address1Value\",
    \"address2\": \"address2Value\",
    \"city\": \"cityValue\",
    \"state\": \"stateValue\",
    \"postcode\": \"postcodeValue\",
    \"country\": \"countryValue\",
    \"phonenumber\": \"phonenumberValue\"
}"

curl -X PUT "https://vservs.com/client-area/api/contact/@id" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "privileges" => "privilegesValue",
        "type" => "typeValue",
        "companyname" => "companynameValue",
        "businessregistrationnumber" => "businessregistrationnumberValue",
        "vateu" => "vateuValue",
        "firstname" => "firstnameValue",
        "lastname" => "lastnameValue",
        "email" => "emailValue",
        "address1" => "address1Value",
        "address2" => "address2Value",
        "city" => "cityValue",
        "state" => "stateValue",
        "postcode" => "postcodeValue",
        "country" => "countryValue",
        "phonenumber" => "phonenumberValue"
    ]
]
$resp = $client->put('contact/@id', $options);
echo $resp->getBody();

payload = {
    'privileges': "privilegesValue",
    'type': "typeValue",
    'companyname': "companynameValue",
    'businessregistrationnumber': "businessregistrationnumberValue",
    'vateu': "vateuValue",
    'firstname': "firstnameValue",
    'lastname': "lastnameValue",
    'email': "emailValue",
    'address1': "address1Value",
    'address2': "address2Value",
    'city': "cityValue",
    'state': "stateValue",
    'postcode': "postcodeValue",
    'country': "countryValue",
    'phonenumber': "phonenumberValue"
}

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/contact/@id', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "info": [
        "profile_updated"
    ]
}

HTTP Request

PUT /contact/@id

Query Parameters

Parameter	Type	Description
id	int
privileges	array	Array with privileges that you want to enable. Formatted the same way as output from GET /contact/privileges
type	string	Account Type Available values: Private, Company.
companyname	string	Organization
businessregistrationnumber	string	Business registration number
vateu	string	VAT EU - If you have valid VAT-EU registered number please provide it here
firstname	string	First Name
lastname	string	Last Name
email	string	Email Address
address1	string	Address 1
address2	string	Address 2
city	string	City
state	string	State
postcode	string	Post code - Example 1000AB do not use spaces like 1000 AB
country	string	Country
phonenumber	string	Phone

List all portal notifications

Return a list of all portal notifications.

curl -X GET "https://vservs.com/client-area/api/notifications" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('notifications');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/notifications', auth=auth)
print(req.json())

HTTP Request

GET /notifications

Query Parameters

Parameter	Type	Description
rel_type	string	Optional, return only by relation type
rel_id	string	Optional, return only by relation id

List new portal notifications

Return only new portal notifications.

curl -X GET "https://vservs.com/client-area/api/notifications/new" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('notifications/new');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/notifications/new', auth=auth)
print(req.json())

HTTP Request

GET /notifications/new

Query Parameters

Parameter	Type	Description
rel_type	string	Optional, return only by relation type
rel_id	string	Optional, return only by relation id

Acknowledge notification

Marks the notification as read

curl -X PUT "https://vservs.com/client-area/api/notifications/@id/ack" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->put('notifications/@id/ack');
echo $resp->getBody();

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/notifications/@id/ack', auth=auth)
print(req.json())

HTTP Request

PUT /notifications/@id/ack

Query Parameters

Parameter	Type	Description
id	int

Get all news

Return a list of all news.

curl -X GET "https://vservs.com/client-area/api/news" 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
]);


$resp = $client->get('news');
echo $resp->getBody();

req = requests.get('https://vservs.com/client-area/api/news')
print(req.json())

Example Response:

{
    "news": [
        {
            "id": "1",
            "title": "Example title",
            "date": "2010-01-01",
            "language_id": "1",
            "slug": "example-slug"
        }
    ]
}

HTTP Request

GET /news

Get news item

Return a single news item.

curl -X GET "https://vservs.com/client-area/api/news/@id" 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
]);


$resp = $client->get('news/@id');
echo $resp->getBody();

req = requests.get('https://vservs.com/client-area/api/news/@id')
print(req.json())

Example Response:

{
    "annoucement": {
        "id": "1",
        "title": "Example title",
        "content": "Example content",
        "date": "2010-01-01",
        "language_id": "1",
        "slug": "example-slug"
    }
}

HTTP Request

GET /news/@id

Query Parameters

Parameter	Type	Description
id	int	News id

Billing

Account balance

Get current account balance(unpaid invoices total), account credit

curl -X GET "https://vservs.com/client-area/api/balance" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('balance');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/balance', auth=auth)
print(req.json())

Example Response:

{
    {
        "success": true,
        "details": {
            "currency": "USD",
            "acc_balance": "123456.55",
            "acc_credit": "0.00"
        }
    }
}

HTTP Request

GET /balance

List Invoices

List all invoices under my account

curl -X GET "https://vservs.com/client-area/api/invoice" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('invoice');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/invoice', auth=auth)
print(req.json())

Example Response:

{
    "invoices": [
        {
            "id": "308976",
            "date": "2016-12-30",
            "dateorig": "2016-12-30",
            "duedate": "2017-01-06",
            "paybefore": "2017-01-06",
            "total": "19.65",
            "datepaid": "2016-12-30 12:40:47",
            "status": "Paid",
            "merge_id": null,
            "number": "2016\/12\/1",
            "currency": "USD"
        }
    ]
}

HTTP Request

GET /invoice

Invoice Details

Get invoice details

curl -X GET "https://vservs.com/client-area/api/invoice/@id" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('invoice/@id');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/invoice/@id', auth=auth)
print(req.json())

Example Response:

{
    "invoice": {
        "id": "308976",
        "status": "Paid",
        "date": "2016-12-30",
        "duedate": "2017-01-06",
        "paybefore": "2017-01-06",
        "datepaid": "2016-12-30 12:40:47",
        "subtotal": 16.24,
        "credit": 0,
        "tax": 3.41,
        "taxrate": 21,
        "tax2": 0,
        "taxrate2": 0,
        "taxexempt": "0",
        "total": 19.65,
        "rate": 1,
        "rate2": 0,
        "rate3": 1,
        "notes": "",
        "items": [
            {
                "id": "12305",
                "invoice_id": "308976",
                "type": "Other",
                "item_id": "0",
                "description": "Example Service",
                "amount": "15.00",
                "taxed": "1",
                "qty": "1.00",
                "linetotal": "15.00"
            },
            {
                "id": "12309",
                "invoice_id": "308976",
                "type": "Other",
                "item_id": "-2",
                "description": "PayPal Payment Fee",
                "amount": "1.24",
                "taxed": "1",
                "qty": "1.00",
                "linetotal": "1.24"
            }
        ],
        "client": {
            "id": "26",
            "email": "api@example.com",
            "firstname": "Joe",
            "lastname": "Doe",
            "companyname": "",
            "address1": "Pretty View Lane",
            "address2": "3194",
            "city": "Santa Rosa",
            "state": "California",
            "postcode": "95401",
            "country": "US",
            "phonenumber": "+1.24123123"
        },
        "number": "2016\/12\/1",
        "currency": "USD"
    }
}

HTTP Request

GET /invoice/@id

Query Parameters

Parameter	Type	Description
id	int

Apply credit

Apply account credit to invoice

POST_DATA="{
    \"amount\": \"amountValue\"
}"

curl -X POST "https://vservs.com/client-area/api/invoice/@id/credit" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "amount" => "amountValue"
    ]
]
$resp = $client->post('invoice/@id/credit', $options);
echo $resp->getBody();

payload = {
    'amount': "amountValue"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/invoice/@id/credit', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "success": true,
    "invoice_status": "Paid",
    "applied": 2.1
}

HTTP Request

POST /invoice/@id/credit

Query Parameters

Parameter	Type	Description
id	int
amount	number	Optional credit amount, when no value is specified maximum amount to fully pay the invoice will be used

Payment Methods

List available payment methods

curl -X GET "https://vservs.com/client-area/api/payment" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('payment');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/payment', auth=auth)
print(req.json())

Example Response:

{
    "payments": {
        "10": "BankTransfer",
        "9": "PayPal"
    }
}

HTTP Request

GET /payment

Payment Methods Fees

List available payment methods with fees

curl -X GET "https://vservs.com/client-area/api/payment/fees" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('payment/fees');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/payment/fees', auth=auth)
print(req.json())

Example Response:

{
    "payments": [
        {
            "id": 1,
            "name": "Bank Transfer",
            "fixed_fee": "0.0",
            "percent_fee": "0.0",
        },
        {
            "id": 2,
            "name": "Stripe",
            "fixed_fee": "0.5",
            "percent_fee": "2.9",
        },
        {
            "id": 4,
            "name": "Credit Card",
            "fixed_fee": "0.1",
            "percent_fee": "2.4"
        },
        {
            "id": 5,
            "name": "PayPal",
            "fixed_fee": "0.3",
            "percent_fee": "2.9"
        }
    ]
}

HTTP Request

GET /payment/fees

Support

List Tickets

List support tickets under my account

curl -X GET "https://vservs.com/client-area/api/tickets" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('tickets');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/tickets', auth=auth)
print(req.json())

Example Response:

{
    "tickets": [
        {
            "client_read": "1",
            "ticket_number": "736633",
            "date": "2016-12-30 12:48:13",
            "deptname": "Billing",
            "subject": "Lore Ipsum",
            "status": "Open",
            "lastreply": "2020-09-12 11:10:03"
        }
    ]
}

HTTP Request

GET /tickets

Ticket details

Get ticket details, including all replies

curl -X GET "https://vservs.com/client-area/api/tickets/@number" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('tickets/@number');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/tickets/@number', auth=auth)
print(req.json())

Example Response:

{
    "ticket": {
        "date": "2016-12-30 12:48:13",
        "ticket_number": "736633",
        "name": "Joe Doe",
        "email": "api@example.com",
        "subject": "Lore Ipsum",
        "body": "Donec sollicitudin molestie malesuada. \r\nSed porttitor lectus nibh. Vivamus magna justo, \r\nlacinia eget consectetur sed, convallis at tellus.",
        "status": "Answered",
        "client_read": "1",
        "deptname": "Billing"
    },
    "replies": [
        {
            "id": "929",
            "name": "Suppport Staff",
            "date": "2016-12-30 12:51:04",
            "body": "Vestibulum ac diam sit amet quam \r\nvehicula elementum sed sit amet dui. \r\nPraesent sapien massa\r\n\r\n-- Maecenas efficitur elit est --",
            "status": "Sent",
            "type": "Admin"
        }
    ]
}

HTTP Request

GET /tickets/@number

Query Parameters

Parameter	Type	Description
number	int	Ticket number

Ticket attachment

Get ticket attachment

curl -X GET "https://vservs.com/client-area/api/ticket/attachment/@file" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('ticket/attachment/@file');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/ticket/attachment/@file', auth=auth)
print(req.json())

HTTP Request

GET /ticket/attachment/@file

Query Parameters

Parameter	Type	Description
number	int	Ticket number
file	string	Attachment id

Create Ticket

Submit new ticket

POST_DATA="{
    \"dept_id\": 1,
    \"subject\": \"Subject\",
    \"body\": \"Message ...\",
    \"encrypt\": \"1\"
}"

curl -X POST "https://vservs.com/client-area/api/tickets" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "dept_id" => 1,
        "subject" => "Subject",
        "body" => "Message ...",
        "encrypt" => "1"
    ]
]
$resp = $client->post('tickets', $options);
echo $resp->getBody();

payload = {
    'dept_id': 1,
    'subject': "Subject",
    'body': "Message ...",
    'encrypt': "1"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/tickets', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "ticket": 865650
}

HTTP Request

POST /tickets

Query Parameters

Parameter	Type	Description
dept_id	int	Department id
subject	string	Ticket subject
body	string	Ticket message
encrypt	string	Add with value 1 if ticket message contain sensitive data

Create Reply

Reply to ticket

POST_DATA="{
    \"body\": \"reply text ..\",
    \"encrypt\": \"1\"
}"

curl -X POST "https://vservs.com/client-area/api/tickets/@number" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "body" => "reply text ..",
        "encrypt" => "1"
    ]
]
$resp = $client->post('tickets/@number', $options);
echo $resp->getBody();

payload = {
    'body': "reply text ..",
    'encrypt': "1"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/tickets/@number', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "info": [
        "reply_added"
    ]
}

HTTP Request

POST /tickets/@number

Query Parameters

Parameter	Type	Description
number	int	Ticket number
body	string	Reply message
encrypt	string	Add with value 1 if reply message contain sensitive data

Re-open ticket

Try to re-open closed ticket

curl -X PUT "https://vservs.com/client-area/api/tickets/@number/open" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->put('tickets/@number/open');
echo $resp->getBody();

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/tickets/@number/open', auth=auth)
print(req.json())

Example Response:

{
    "status": true
}

HTTP Request

PUT /tickets/@number/open

Query Parameters

Parameter	Type	Description
number	int	Ticket number

Close ticket

Send request to close a ticket

curl -X PUT "https://vservs.com/client-area/api/tickets/@number/close" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->put('tickets/@number/close');
echo $resp->getBody();

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/tickets/@number/close', auth=auth)
print(req.json())

Example Response:

{
    "status": true
}

HTTP Request

PUT /tickets/@number/close

Query Parameters

Parameter	Type	Description
number	int	Ticket number

List ticket departments

Get the list of ticket departments

curl -X GET "https://vservs.com/client-area/api/ticket/departments" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('ticket/departments');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/ticket/departments', auth=auth)
print(req.json())

HTTP Request

GET /ticket/departments

Get all knowledgebase categories

Return a list of all knowledgebase categories.

curl -X GET "https://vservs.com/client-area/api/knowledgebase" 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
]);


$resp = $client->get('knowledgebase');
echo $resp->getBody();

req = requests.get('https://vservs.com/client-area/api/knowledgebase')
print(req.json())

Example Response:

{
    "categories": [
        {
            "id": "1",
            "parent_cat": "0",
            "name": "Example name",
            "description": "Example description",
            "slug": "example-slug",
            "elements": "2"
        }
    ]
}

HTTP Request

GET /knowledgebase

Get knowledgebase category items

Return subcategories and articles of a single category.

curl -X GET "https://vservs.com/client-area/api/knowledgebase/@id" 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
]);


$resp = $client->get('knowledgebase/@id');
echo $resp->getBody();

req = requests.get('https://vservs.com/client-area/api/knowledgebase/@id')
print(req.json())

Example Response:

{
    "subcategories": [
        {
            "id": "1",
            "parent_cat": "1",
            "name": "Example name",
            "description": "Example description",
            "slug": "example-slug",
            "elements": "1"
        }
    ],
    "articles": [
        {
            "id": "1",
            "language_id": "1",
            "cat_id": "1",
            "title": "Example title",
            "body": "Example body",
            "views": "1",
            "slug": "example-slug",
            "upvotes": "1",
            "downvotes": "1",
            "tag_title": "Example title",
            "tag_body": "Example body"
        }
    ]
}

HTTP Request

GET /knowledgebase/@id

Query Parameters

Parameter	Type	Description
id	int	Category id

Get knowledgebase article

Return an article details.

curl -X GET "https://vservs.com/client-area/api/knowledgebase/article/@id" 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
]);


$resp = $client->get('knowledgebase/article/@id');
echo $resp->getBody();

req = requests.get('https://vservs.com/client-area/api/knowledgebase/article/@id')
print(req.json())

Example Response:

{
    "article": {
        "id": "1",
        "language_id": "1",
        "cat_id": "1",
        "title": "Example title",
        "body": "Example body",
        "views": "1",
        "slug": "example-slug",
        "upvotes": "1",
        "downvotes": "1",
        "tag_title": "Example title",
        "tag_body": "Example body"
    }
}

HTTP Request

GET /knowledgebase/article/@id

Query Parameters

Parameter	Type	Description
id	int	Article id

Domains

List Domains

List domains under your account

curl -X GET "https://vservs.com/client-area/api/domain" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain', auth=auth)
print(req.json())

Example Response:

{
    "domains": [
        {
            "id": "47",
            "name": "testname.com",
            "expires": "2017-12-30",
            "recurring_amount": "15.00",
            "date_created": "2016-12-30",
            "status": "Active",
            "period": "1",
            "autorenew": "1",
            "daytoexpire": "365"
        }
    ]
}

HTTP Request

GET /domain

Domain details

Get domain details

curl -X GET "https://vservs.com/client-area/api/domain/@id" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id', auth=auth)
print(req.json())

Example Response:

{
    "details": {
        "id": "47",
        "name": "testname.com",
        "date_created": "2016-12-30",
        "firstpayment": "10.00",
        "recurring_amount": "15.00",
        "period": "1",
        "expires": "2017-12-30",
        "status": "Active",
        "next_due": "2017-12-30",
        "next_invoice": "2017-11-30",
        "idprotection": "0",
        "nameservers": [
            "ns1.example.com",
            "ns2.example.com",
            "ns3.example.com",
            "ns4.example.com"
        ],
        "autorenew": "1"
    }
}

HTTP Request

GET /domain/@id

Query Parameters

Parameter	Type	Description
id	int	Domain id

Domain details by name

Get domain details by name

curl -X GET "https://vservs.com/client-area/api/domain/name/@name" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/name/@name');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/name/@name', auth=auth)
print(req.json())

Example Response:

{
    "details": [
        {
            "id": "47",
            "name": "testname.com",
            "date_created": "2016-12-30",
            "firstpayment": "10.00",
            "recurring_amount": "15.00",
            "period": "1",
            "expires": "2017-12-30",
            "status": "Active",
            "next_due": "2017-12-30",
            "next_invoice": "2017-11-30",
            "idprotection": "0",
            "nameservers": [
                "ns1.example.com",
                "ns2.example.com",
                "ns3.example.com",
                "ns4.example.com"
            ],
            "autorenew": "1"
        },
        {
            "id": "48",
            "name": "testname.com",
            "date_created": "2016-05-30",
            "firstpayment": "10.00",
            "recurring_amount": "15.00",
            "period": "1",
            "expires": "2017-05-30",
            "status": "Expired",
            "next_due": "2017-05-30",
            "next_invoice": "2017-04-30",
            "idprotection": "0",
            "nameservers": [
                "ns1.example.com",
                "ns2.example.com",
                "ns3.example.com",
                "ns4.example.com"
            ],
            "autorenew": "1"
        },
    ]
}

HTTP Request

GET /domain/name/@name

Query Parameters

Parameter	Type	Description
name	string	Domain name

Get domain nameservers

curl -X GET "https://vservs.com/client-area/api/domain/@id/ns" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/ns');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/ns', auth=auth)
print(req.json())

HTTP Request

GET /domain/@id/ns

Query Parameters

Parameter	Type	Description
id	int	Domain id

Update domain nameservers

Change domain nameservers, if $nameservers is left empty, default namesevers will be used

POST_DATA="{
    \"nameservers\": \"nameserversValue\"
}"

curl -X PUT "https://vservs.com/client-area/api/domain/@id/ns" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "nameservers" => "nameserversValue"
    ]
]
$resp = $client->put('domain/@id/ns', $options);
echo $resp->getBody();

payload = {
    'nameservers': "nameserversValue"
}

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/domain/@id/ns', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "info": [
        "success_changes_save"
    ]
}

HTTP Request

PUT /domain/@id/ns

Query Parameters

Parameter	Type	Description
id	int	Domain id
nameservers	array	List of nameservers to use

Register domain nameservers

curl -X POST "https://vservs.com/client-area/api/domain/@id/reg" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->post('domain/@id/reg');
echo $resp->getBody();

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/domain/@id/reg', auth=auth)
print(req.json())

HTTP Request

POST /domain/@id/reg

Query Parameters

Parameter	Type	Description
id	int	Domain id

DNS Records DNS Records

List DNS records

curl -X GET "https://vservs.com/client-area/api/domain/@id/dns" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/dns');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/dns', auth=auth)
print(req.json())

Example Response:

{
    "records": [
        {
            "id": 1,
            "name": "test",
            "ttl": 0,
            "priority": 0,
            "type": "A",
            "content": "100.100.10.1"
        }
    ]
}

HTTP Request

GET /domain/@id/dns

Query Parameters

Parameter	Type	Description
id	int	Domain id

Create DNS Records

Add a new DNS record

POST_DATA="{
    \"name\": \"nameValue\",
    \"type\": \"typeValue\",
    \"priority\": \"priorityValue\",
    \"content\": \"contentValue\"
}"

curl -X POST "https://vservs.com/client-area/api/domain/@id/dns" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "name" => "nameValue",
        "type" => "typeValue",
        "priority" => "priorityValue",
        "content" => "contentValue"
    ]
]
$resp = $client->post('domain/@id/dns', $options);
echo $resp->getBody();

payload = {
    'name': "nameValue",
    'type': "typeValue",
    'priority': "priorityValue",
    'content': "contentValue"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/domain/@id/dns', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "info": [
        "DNS Management updated successfully"
    ]
}

HTTP Request

POST /domain/@id/dns

Query Parameters

Parameter	Type	Description
id	int	Domain id
name	string	Reord name
type	string	Reord type
priority	string	Reord priority
content	string	Reord content eg. IP addres for A records

Update DNS Records

Change a DNS record

POST_DATA="{
    \"name\": \"nameValue\",
    \"type\": \"typeValue\",
    \"priority\": \"priorityValue\",
    \"content\": \"contentValue\"
}"

curl -X PUT "https://vservs.com/client-area/api/domain/@id/dns/@index" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "name" => "nameValue",
        "type" => "typeValue",
        "priority" => "priorityValue",
        "content" => "contentValue"
    ]
]
$resp = $client->put('domain/@id/dns/@index', $options);
echo $resp->getBody();

payload = {
    'name': "nameValue",
    'type': "typeValue",
    'priority': "priorityValue",
    'content': "contentValue"
}

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/domain/@id/dns/@index', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "info": [
        "DNS Management updated successfully"
    ]
}

HTTP Request

PUT /domain/@id/dns/@index

Query Parameters

Parameter	Type	Description
id	int	Domain id
record_id	int	Recod index
name	string	Record name
type	string	Record type
priority	string	Record priority
content	string	Record content eg. IP address for A records

Remove DNS Records

Remove a DNS record

curl -X DELETE "https://vservs.com/client-area/api/domain/@id/dns/@index" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->delete('domain/@id/dns/@index');
echo $resp->getBody();

auth=('username', 'password')

req = requests.delete('https://vservs.com/client-area/api/domain/@id/dns/@index', auth=auth)
print(req.json())

Example Response:

{
    "info": [
        "DNS Management updated successfully"
    ]
}

HTTP Request

DELETE /domain/@id/dns/@index

Query Parameters

Parameter	Type	Description
id	int	Domain id
record_id	int	Recod index

DNS Records Types

List supported records type

curl -X GET "https://vservs.com/client-area/api/domain/@id/dns/types" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/dns/types');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/dns/types', auth=auth)
print(req.json())

Example Response:

{
    "types": [
        "A",
        "CNAME",
        "URL",
        "FRAME",
        "MX",
        "MXE",
        "TXT"
    ]
}

HTTP Request

GET /domain/@id/dns/types

Query Parameters

Parameter	Type	Description
id	int	Domain id

Get domain EPP Code

curl -X GET "https://vservs.com/client-area/api/domain/@id/epp" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/epp');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/epp', auth=auth)
print(req.json())

HTTP Request

GET /domain/@id/epp

Query Parameters

Parameter	Type	Description
id	int	Domain id

Synchronize domain

curl -X GET "https://vservs.com/client-area/api/domain/@id/sync" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/sync');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/sync', auth=auth)
print(req.json())

HTTP Request

GET /domain/@id/sync

Query Parameters

Parameter	Type	Description
id	int	Domain id

Get domain lock

curl -X GET "https://vservs.com/client-area/api/domain/@id/reglock" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/reglock');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/reglock', auth=auth)
print(req.json())

HTTP Request

GET /domain/@id/reglock

Query Parameters

Parameter	Type	Description
id	int	Domain id

Update domain lock

curl -X PUT "https://vservs.com/client-area/api/domain/@id/reglock" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->put('domain/@id/reglock');
echo $resp->getBody();

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/domain/@id/reglock', auth=auth)
print(req.json())

HTTP Request

PUT /domain/@id/reglock

Query Parameters

Parameter	Type	Description
id	int	Domain id

Update domain ID Protection

curl -X PUT "https://vservs.com/client-area/api/domain/@id/idprotection" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->put('domain/@id/idprotection');
echo $resp->getBody();

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/domain/@id/idprotection', auth=auth)
print(req.json())

HTTP Request

PUT /domain/@id/idprotection

Query Parameters

Parameter	Type	Description
id	int	Domain id

Get domain contact info

curl -X GET "https://vservs.com/client-area/api/domain/@id/contact" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/contact');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/contact', auth=auth)
print(req.json())

HTTP Request

GET /domain/@id/contact

Query Parameters

Parameter	Type	Description
id	int	Domain id

Update domain contact info

curl -X PUT "https://vservs.com/client-area/api/domain/@id/contact" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->put('domain/@id/contact');
echo $resp->getBody();

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/domain/@id/contact', auth=auth)
print(req.json())

HTTP Request

PUT /domain/@id/contact

Query Parameters

Parameter	Type	Description
id	int	Domain id

Get email forwarding

curl -X GET "https://vservs.com/client-area/api/domain/@id/emforwarding" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/emforwarding');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/emforwarding', auth=auth)
print(req.json())

HTTP Request

GET /domain/@id/emforwarding

Query Parameters

Parameter	Type	Description
id	int	Domain id

Update email forwarding

curl -X PUT "https://vservs.com/client-area/api/domain/@id/emforwarding" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->put('domain/@id/emforwarding');
echo $resp->getBody();

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/domain/@id/emforwarding', auth=auth)
print(req.json())

HTTP Request

PUT /domain/@id/emforwarding

Query Parameters

Parameter	Type	Description
id	int	Domain id

Update domain forwarding

curl -X PUT "https://vservs.com/client-area/api/domain/@id/forwarding" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->put('domain/@id/forwarding');
echo $resp->getBody();

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/domain/@id/forwarding', auth=auth)
print(req.json())

HTTP Request

PUT /domain/@id/forwarding

Query Parameters

Parameter	Type	Description
id	int	Domain id

Get domain autorenew

curl -X GET "https://vservs.com/client-area/api/domain/@id/autorenew" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/autorenew');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/autorenew', auth=auth)
print(req.json())

HTTP Request

GET /domain/@id/autorenew

Query Parameters

Parameter	Type	Description
id	int	Domain id

Enable/disable domain autorenew

curl -X PUT "https://vservs.com/client-area/api/domain/@id/autorenew" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->put('domain/@id/autorenew');
echo $resp->getBody();

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/domain/@id/autorenew', auth=auth)
print(req.json())

HTTP Request

PUT /domain/@id/autorenew

Query Parameters

Parameter	Type	Description
id	int	Domain id

Returns the available flags

curl -X GET "https://vservs.com/client-area/api/domain/@id/dnssec/flags" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/dnssec/flags');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/dnssec/flags', auth=auth)
print(req.json())

HTTP Request

GET /domain/@id/dnssec/flags

Query Parameters

Parameter	Type	Description
id	int	Domain id

Returns the list of DNSSEC keys

curl -X GET "https://vservs.com/client-area/api/domain/@id/dnssec" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/@id/dnssec');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/@id/dnssec', auth=auth)
print(req.json())

HTTP Request

GET /domain/@id/dnssec

Query Parameters

Parameter	Type	Description
id	int	Domain id

Adds the DNSSEC key

curl -X PUT "https://vservs.com/client-area/api/domain/@id/dnssec" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->put('domain/@id/dnssec');
echo $resp->getBody();

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/domain/@id/dnssec', auth=auth)
print(req.json())

HTTP Request

PUT /domain/@id/dnssec

Query Parameters

Parameter	Type	Description
id	int	Domain id

curl -X DELETE "https://vservs.com/client-area/api/domain/@id/dnssec/@key" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->delete('domain/@id/dnssec/@key');
echo $resp->getBody();

auth=('username', 'password')

req = requests.delete('https://vservs.com/client-area/api/domain/@id/dnssec/@key', auth=auth)
print(req.json())

HTTP Request

DELETE /domain/@id/dnssec/@key

Query Parameters

Parameter	Type	Description
id	int	Domain id
key	string

Domain availability

Check if domain is available for registration. Returns status: "ok" if domain is available, empty response otherwise

POST_DATA="{
    \"name\": \"example.com\"
}"

curl -X POST "https://vservs.com/client-area/api/domain/lookup" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "name" => "example.com"
    ]
]
$resp = $client->post('domain/lookup', $options);
echo $resp->getBody();

payload = {
    'name': "example.com"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/domain/lookup', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "available": false,
    "name": "example.com",
    "premium": false,
    "periods": [
        {
            "id": "6",
            "period": "1",
            "register": "10.00",
            "transfer": "0.00",
            "renew": "15.00",
            "redemption": "40.00"
        },
        {
            "id": "6",
            "period": "2",
            "register": "20.00",
            "transfer": "20.00",
            "renew": "20.00",
            "redemption": "80.00"
        }
    ]
}

HTTP Request

POST /domain/lookup

Query Parameters

Parameter	Type	Description
name	string	Domain name

Available TLDs

List TLDs available for registration and transfer

curl -X GET "https://vservs.com/client-area/api/domain/order" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/order');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/order', auth=auth)
print(req.json())

Example Response:

{
    "tlds": [
        {
            "id": "6",
            "tld": ".com",
            "periods": [
                {
                    "period": "1",
                    "register": "10.00",
                    "transfer": "0.00",
                    "renew": "15.00",
                    "redemption": "40.00"
                },
                {
                    "period": "2",
                    "register": "20.00",
                    "transfer": "20.00",
                    "renew": "30.00",
                    "redemption": "80.00"
                }
            ]
        },
        (...)
    ]
}

HTTP Request

GET /domain/order

Additinal data for TLD

Get additional forms required for some TLDs

curl -X GET "https://vservs.com/client-area/api/domain/order/@id/form" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('domain/order/@id/form');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/domain/order/@id/form', auth=auth)
print(req.json())

Example Response:

{
    "forms": [
        {
            "type": "domaindnssupport",
            "title": "DNS Management",
            "id": "1424",
            "firstItemId": 9067,
            "description": "",
            "name": "custom[1424][9067]",
            "required": false,
            "multiple": false,
            "config": {
                "enableddefault": 0
            },
            "value": [],
            "textvalue": [],
            "price": 0,
            "recurring_price": 0,
            "setup": 0,
            "prorata_date": null,
            "items": [
                {
                    "title": "",
                    "value": 1,
                    "id": 9067,
                    "price": 4,
                    "setup": 0,
                    "selected": false
                }
            ]
        },
        {
            "type": "select",
            "title": "Language",
            "id": "1755",
            "firstItemId": 10952,
            "description": "",
            "name": "custom[1755]",
            "required": false,
            "multiple": false,
            "config": {
                "conditionals": []
            },
            "value": [],
            "textvalue": [],
            "price": 0,
            "recurring_price": 0,
            "setup": 0,
            "prorata_date": null,
            "items": [
                {
                    "title": "AFR",
                    "value": 1,
                    "id": 10952,
                    "price": 0,
                    "setup": 0,
                    "selected": false
                },
                {
                    "title": "ALB",
                    "value": 1,
                    "id": 10953,
                    "price": 0,
                    "setup": 0,
                    "selected": false
                },
                (...)
            ]
        }
    ]
}

HTTP Request

GET /domain/order/@id/form

Query Parameters

Parameter	Type	Description
tld_id	int	TLD ID

Order new domain

Create new order for a domain, please check if requested domain is available first, otherwise your order may get cancelled.

POST_DATA="{
    \"name\": \"example.com\",
    \"years\": \"yearsValue\",
    \"action\": \"actionValue\",
    \"tld_id\": \"tld_idValue\",
    \"pay_method\": \"pay_methodValue\",
    \"epp\": \"eppValue\",
    \"nameservers\": \"nameserversValue\",
    \"registrant\": \"registrantValue\",
    \"admin\": \"adminValue\",
    \"tech\": \"techValue\",
    \"billing\": \"billingValue\",
    \"data\": \"dataValue\",
    \"aff_id\": 55
}"

curl -X POST "https://vservs.com/client-area/api/domain/order" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "name" => "example.com",
        "years" => "yearsValue",
        "action" => "actionValue",
        "tld_id" => "tld_idValue",
        "pay_method" => "pay_methodValue",
        "epp" => "eppValue",
        "nameservers" => "nameserversValue",
        "registrant" => "registrantValue",
        "admin" => "adminValue",
        "tech" => "techValue",
        "billing" => "billingValue",
        "data" => "dataValue",
        "aff_id" => 55
    ]
]
$resp = $client->post('domain/order', $options);
echo $resp->getBody();

payload = {
    'name': "example.com",
    'years': "yearsValue",
    'action': "actionValue",
    'tld_id': "tld_idValue",
    'pay_method': "pay_methodValue",
    'epp': "eppValue",
    'nameservers': "nameserversValue",
    'registrant': "registrantValue",
    'admin': "adminValue",
    'tech': "techValue",
    'billing': "billingValue",
    'data': "dataValue",
    'aff_id': 55
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/domain/order', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "order_num": 563647679,
    "invoice_id": "308977",
    "total": "10.00",
    "items": {
        "id": "10",
        "type": "Domain Register",
        "name": "test.com",
        "product_id": "3"
    }
}

HTTP Request

POST /domain/order

Query Parameters

Parameter	Type	Description
name	string	Domain name
years	string	Number of years
action	string	register|transfer
tld_id	string	TLD id
pay_method	int	Payment method ID
epp	string	EPP Transfer code, required when transfering some domains
nameservers	array	Optional array with 2 - 4 nameservers that you want to use
registrant	int	Optional contact ID to use for registrant contact this domain
admin	int	Optional contact ID to use for admin contact this domain
tech	int	Optional contact ID to use for tech contact this domain
billing	int	Optional contact ID to use for billing contact this domain
data	array	Addditional data required for some TLDs
aff_id	int	Affiliate ID

Renew domain

Create new renew order for a domain, please check if requested domain is available first, otherwise your order may get cancelled.

POST_DATA="{
    \"years\": \"yearsValue\",
    \"pay_method\": \"pay_methodValue\"
}"

curl -X POST "https://vservs.com/client-area/api/domain/@id/renew" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "years" => "yearsValue",
        "pay_method" => "pay_methodValue"
    ]
]
$resp = $client->post('domain/@id/renew', $options);
echo $resp->getBody();

payload = {
    'years': "yearsValue",
    'pay_method': "pay_methodValue"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/domain/@id/renew', json=payload, auth=auth)
print(req.json())

HTTP Request

POST /domain/@id/renew

Query Parameters

Parameter	Type	Description
id	int
years	string	Number of years
pay_method	int	Payment method ID

SSL Certificates

List SSL Certificates

List all ssl services under your account

curl -X GET "https://vservs.com/client-area/api/certificate" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('certificate');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/certificate', auth=auth)
print(req.json())

Example Response:

{
    "sslservices": [
        {
            "id": "300",
            "domain": "examplename.com",
            "total": "27.85",
            "status": "Pending",
            "billingcycle": "Annually",
            "next_due": "2017-12-30",
            "category": "GoGetSSL",
            "category_url": "gogetssl",
            "name": "Comodo InstantSSL",
            "cert_email": "admin@example.com",
            "cert_status": "",
            "cert_expires": "2017-12-30 13:43:12"
        }
    ]
}

HTTP Request

GET /certificate

Certificate details

Return details for certificate @id

curl -X GET "https://vservs.com/client-area/api/certificate/@id" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('certificate/@id');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/certificate/@id', auth=auth)
print(req.json())

Example Response:

{
    "service": {
        "id": "300",
        "date_created": "2016-12-30",
        "domain": "examplename.com",
        "firstpayment": "27.85",
        "total": "27.85",
        "billingcycle": "Annually",
        "next_due": "2017-12-30",
        "next_invoice": "2017-10-31",
        "status": "Pending",
        "label": "",
        "name": "Comodo InstantSSL",
        "cert_status": "",
        "cert_expires": "2017-12-30 13:43:12",
        "csr": "-----BEGIN CERTIFICATE REQUEST----- ...",
        "contacts": {
            "admin": {
                "FName": "Mary",
                "LName": "Sue",
                "City": "Santa Rosa",
                "State": "California",
                "PostalCode": "95401",
                "EmailAddress": "mary@example.com",
                "Country": "US",
                "Address1": "Pretty View Lane",
                "Address2": "3194",
                "Phone": 24123223,
                "OrgName": "n\/a",
                "PreFix": 1,
                "JobTitle": "n\/a"
            },
            "billing": {
                (...)
            },
            "tech": {
                (...)
            }
        },
        "organization": {
            "state": "Texas",
            "country": "US",
            "name": "My Org name",
            "unit": "Dev",
            "locality": "SanAntonio",
            "postalcode": "n\/a",
            "address2": "n\/a",
            "address1": "n\/a",
        },
        "cert_email": "admin@example.com",
        "software": "1"
    }
}

HTTP Request

GET /certificate/@id

Query Parameters

Parameter	Type	Description
id	int	Service id

Download certificate

Return X.509 certificate data

curl -X GET "https://vservs.com/client-area/api/certificate/@id/crt" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('certificate/@id/crt');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/certificate/@id/crt', auth=auth)
print(req.json())

HTTP Request

GET /certificate/@id/crt

Query Parameters

Parameter	Type	Description
id	int	Service id

List available certificates

Return a list with certificate available for purchase

curl -X GET "https://vservs.com/client-area/api/certificate/order" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('certificate/order');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/certificate/order', auth=auth)
print(req.json())

Example Response:

{
    "products": [
        {
            "id": "25",
            "name": "InstantSSL",
            "description": "",
            "periods": [
                {
                    "years": 1,
                    "price": 27.85,
                    "renew": 27.85
                },
                {
                    "years": 2,
                    "price": 48.75,
                    "renew": 48.75
                }
            ],
            "category": "SSL Certificates",
            "category_url": "sslcertificates"
        },
        (...)
    ]
}

HTTP Request

GET /certificate/order

List server software for certificates

Return a list with software IDs required or certificate

curl -X GET "https://vservs.com/client-area/api/certificate/order/@product_id/software" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('certificate/order/@product_id/software');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/certificate/order/@product_id/software', auth=auth)
print(req.json())

Example Response:

{
    "software": [
        {
            "id": 0,
            "name": "AOL"
        },
        {
            "id": 1,
            "name": "Apache-SSL (Ben-SSL, not Stronghold)"
        },
        (...)
    ]
}

HTTP Request

GET /certificate/order/@product_id/software

Query Parameters

Parameter	Type	Description
product_id	int	Certificate product ID

Order new certificates

Create new order for a certificate

POST_DATA="{
    \"product_id\": \"product_idValue\",
    \"csr\": \"example.com\",
    \"years\": \"yearsValue\",
    \"pay_method\": \"pay_methodValue\",
    \"approver_email\": \"approver_emailValue\",
    \"admin\": \"adminValue\",
    \"tech\": \"techValue\",
    \"billing\": \"billingValue\",
    \"organization\": \"organizationValue\",
    \"software\": \"softwareValue\",
    \"data\": \"dataValue\",
    \"aff_id\": 55
}"

curl -X POST "https://vservs.com/client-area/api/certificate/order" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "product_id" => "product_idValue",
        "csr" => "example.com",
        "years" => "yearsValue",
        "pay_method" => "pay_methodValue",
        "approver_email" => "approver_emailValue",
        "admin" => "adminValue",
        "tech" => "techValue",
        "billing" => "billingValue",
        "organization" => "organizationValue",
        "software" => "softwareValue",
        "data" => "dataValue",
        "aff_id" => 55
    ]
]
$resp = $client->post('certificate/order', $options);
echo $resp->getBody();

payload = {
    'product_id': "product_idValue",
    'csr': "example.com",
    'years': "yearsValue",
    'pay_method': "pay_methodValue",
    'approver_email': "approver_emailValue",
    'admin': "adminValue",
    'tech': "techValue",
    'billing': "billingValue",
    'organization': "organizationValue",
    'software': "softwareValue",
    'data': "dataValue",
    'aff_id': 55
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/certificate/order', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "order_num": 873340994,
    "invoice_id": "308978",
    "total": "27.85",
    "items": {
        "id": "10",
        "type": "Hosting",
        "name": "test.com",
        "product_id": "3"
    }
}

HTTP Request

POST /certificate/order

Query Parameters

Parameter	Type	Description
product_id	int	Certificate product ID
csr	string	Domain name
years	int	Number of years
pay_method	int	Payment method ID
approver_email	string	Email addres used in domain validation
admin	int	Admin contact ID
tech	int	Tech contact ID
billing	int	Billing contact ID
organization	array	Organization details
software	int	Server/Software ID
data	array	Addditional data required for some products
aff_id	int	Affiliate ID

Services

List services

List all services under your account

curl -X GET "https://vservs.com/client-area/api/service" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('service');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/service', auth=auth)
print(req.json())

Example Response:

{
    "services": [
        {
            "id": "301",
            "domain": "examplename.com",
            "total": "9.99",
            "status": "Pending",
            "billingcycle": "Monthly",
            "next_due": "2017-12-30",
            "category": "Hosting",
            "category_url": "hosting",
            "name": "Starter Hosting"
        }
    ]
}

HTTP Request

GET /service

Service details

Return details for service @id

curl -X GET "https://vservs.com/client-area/api/service/@id" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('service/@id');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/service/@id', auth=auth)
print(req.json())

Example Response:

{
    "service": {
        "id": "301",
        "date_created": "2016-12-30",
        "domain": "examplename.com",
        "firstpayment": "9.99",
        "total": "9.99",
        "billingcycle": "Monthly",
        "next_due": "2017-12-30",
        "next_invoice": "2017-01-27",
        "status": "Active",
        "label": "",
        "username": "examplen",
        "password": "pdtzc",
        "name": "Starter Hosting"
    }
}

HTTP Request

GET /service/@id

Query Parameters

Parameter	Type	Description
id	int	Service id

List service methods

List methods available for service

curl -X GET "https://vservs.com/client-area/api/service/@id/methods" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('service/@id/methods');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/service/@id/methods', auth=auth)
print(req.json())

Example Response:

{
    "methods": [
        {
            "name": "Upgrade Request",
            "method": "POST",
            "route": "\/service\/@id\/upgrade"
        },
        {
            "name": "Upgrade Options",
            "method": "GET",
            "route": "\/service\/@id\/upgrade"
        },
        {
            "name": "Change service label",
            "method": "POST",
            "route": "\/service\/@id\/label"
        },
        {
            "name": "Service label",
            "method": "GET",
            "route": "\/service\/@id\/label"
        },
        {
            "name": "Cancel Service",
            "method": "POST",
            "route": "\/service\/@id\/cancel"
        }
    ]
}

HTTP Request

GET /service/@id/methods

Query Parameters

Parameter	Type	Description
id	int

Upgrade Options

List upgrade options

curl -X GET "https://vservs.com/client-area/api/service/@id/upgrade" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('service/@id/upgrade');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/service/@id/upgrade', auth=auth)
print(req.json())

Example Response:

{
    "resources": [
        {
            "id": 1557,
            "name": "Bandwidth",
            "type": "select",
            "items": [
                {
                    "id": "9953",
                    "name": "100 GB",
                    "price": 1,
                    "setup_price": 0,
                    "selected": true
                },
                {
                    "id": "10103",
                    "name": "500 GB",
                    "price": 5,
                    "setup_price": 0,
                    "selected": false
                },
                {
                    "id": "10104",
                    "name": "1 TB",
                    "price": 10,
                    "setup_price": 0,
                    "selected": false
                }
            ]
        }
    ],
    "package": []
}

HTTP Request

GET /service/@id/upgrade

Query Parameters

Parameter	Type	Description
id	int

Upgrade Request

Estimate or request upgrade

// Format of ''resources'' paremeter
{
    "resource_id" : "qty_value", // sliders & qty fields
    "resource_id" : "item_id", // dropdown & radio fields
    "resource_id" : {
        "item_id": "qty_value" // dropdown with qty field
    }
}

POST_DATA="{
    \"resources\": \"resourcesValue\",
    \"package\": \"packageValue\",
    \"cycle\": \"cycleValue\",
    \"send\": \"sendValue\"
}"

curl -X POST "https://vservs.com/client-area/api/service/@id/upgrade" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "resources" => "resourcesValue",
        "package" => "packageValue",
        "cycle" => "cycleValue",
        "send" => "sendValue"
    ]
]
$resp = $client->post('service/@id/upgrade', $options);
echo $resp->getBody();

payload = {
    'resources': "resourcesValue",
    'package': "packageValue",
    'cycle': "cycleValue",
    'send': "sendValue"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/service/@id/upgrade', json=payload, auth=auth)
print(req.json())

HTTP Request

POST /service/@id/upgrade

Query Parameters

Parameter	Type	Description
id	int	Service id
resources	array	array with resource values
package	int	New package id, optonal when upgrading resources
cycle	string	New billing cycle, optonal when upgrading resources
send	boolean	Set to true when you want to send your upgrade request

Cancel Service

Request service cancellation

POST_DATA="{
    \"immediate\": \"immediateValue\",
    \"reason\": \"reasonValue\"
}"

curl -X POST "https://vservs.com/client-area/api/service/@id/cancel" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "immediate" => "immediateValue",
        "reason" => "reasonValue"
    ]
]
$resp = $client->post('service/@id/cancel', $options);
echo $resp->getBody();

payload = {
    'immediate': "immediateValue",
    'reason': "reasonValue"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/service/@id/cancel', json=payload, auth=auth)
print(req.json())

Example Response:

{
  "info": [
    "cancell_sent"
  ]
}

HTTP Request

POST /service/@id/cancel

Query Parameters

Parameter	Type	Description
id	int	Service id
immediate	string	set to false to terminate service at the end of billing date, true - terminate immediately
reason	string	Reason for this request

Service label

Show current service label

curl -X GET "https://vservs.com/client-area/api/service/@id/label" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('service/@id/label');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/service/@id/label', auth=auth)
print(req.json())

Example Response:

{
    "label": "example"
}

HTTP Request

GET /service/@id/label

Query Parameters

Parameter	Type	Description
id	int	Service id

Change service label

Set new custom label to identify this service

POST_DATA="{
    \"label\": \"labelValue\"
}"

curl -X POST "https://vservs.com/client-area/api/service/@id/label" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "label" => "labelValue"
    ]
]
$resp = $client->post('service/@id/label', $options);
echo $resp->getBody();

payload = {
    'label': "labelValue"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/service/@id/label', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "success": true,
    "info": [
        "label_updated"
    ]
}

HTTP Request

POST /service/@id/label

Query Parameters

Parameter	Type	Description
id	int	Service id
label	string	New label

Cart

Most of API methods found here will require service @id, you can lookup your service ids with /service method

List product categories

Return a list of product categories.

curl -X GET "https://vservs.com/client-area/api/category" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('category');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/category', auth=auth)
print(req.json())

Example Response:

{
    "categories": [
        {
            "id": "10",
            "name": "Hosting",
            "description": "",
            "slug": "hosting"
        },
        {
            "id": "6",
            "name": "Domains",
            "description": "",
            "slug": "domains"
        },
        {
            "id": "16",
            "name": "Dedicated",
            "description": "",
            "slug": "dedicated"
        }
    ]
}

HTTP Request

GET /category

List products in category

Return a list of product available for purchase under requested category

curl -X GET "https://vservs.com/client-area/api/category/@category_id/product" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('category/@category_id/product');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/category/@category_id/product', auth=auth)
print(req.json())

Example Response:

{
    "products": [
        {
            "id": "333",
            "type": "1",
            "name": "Starter Hosting",
            "stock": false,
            "paytype": "Regular",
            "description": "Disk:10GB
Memory:2GB
MySql:10 DB
Email:100 Users
",
            "qty": "0",
            "tags": [

            ],
            "periods": [
                {
                    "title": "m",
                    "value": "m",
                    "price": 9.99,
                    "setup": 0,
                    "selected": true
                },
                {
                    "title": "a",
                    "value": "a",
                    "price": 109.89,
                    "setup": 0,
                    "selected": false
                },
                {
                    "title": "b",
                    "value": "b",
                    "price": 199.8,
                    "setup": 0,
                    "selected": false
                },
                {
                    "title": "t",
                    "value": "t",
                    "price": 299.7,
                    "setup": 0,
                    "selected": false
                }
            ]
        },
        (...)
    ]
}

HTTP Request

GET /category/@category_id/product

Query Parameters

Parameter	Type	Description
category_id	int	Category ID

Get product configuration details

Return product details with form configuration, addons and subproducts if available.

curl -X GET "https://vservs.com/client-area/api/order/@product_id" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('order/@product_id');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/order/@product_id', auth=auth)
print(req.json())

Example Response:

{
    "product": {
        "id": "333",
        "category_name": "Hosting",
        "category_id": "49",
        "name": "Starter Hosting",
        "price": 9.99,
        "recurring": "m",
        "setup": 0,
        "config": {
            "product": [
                {
                    "type": "select",
                    "title": "pickcycle",
                    "id": "cycle",
                    "name": "cycle",
                    "items": [
                        {
                            "title": "m",
                            "value": "m",
                            "price": 9.99,
                            "setup": 0,
                            "selected": true
                        },
                        {
                            "title": "a",
                            "value": "a",
                            "price": 109.89,
                            "setup": 0,
                            "selected": false
                        },
                        {
                            "title": "b",
                            "value": "b",
                            "price": 199.8,
                            "setup": 0,
                            "selected": false
                        },
                        {
                            "title": "t",
                            "value": "t",
                            "price": 299.7,
                            "setup": 0,
                            "selected": false
                        }
                    ],
                    "value": "m",
                    "price": 9.99,
                    "setup": 0
                },
                {
                    "type": "input",
                    "title": "domain",
                    "id": "domain",
                    "name": "domain",
                    "value": null
                }
            ],
            "forms": [
                {
                    "type": "select",
                    "title": "Disk Size",
                    "id": "1618",
                    "firstItemId": 10330,
                    "description": "",
                    "name": "custom[1618]",
                    "required": false,
                    "multiple": false,
                    "config": {
                        "conditionals": []
                    },
                    "value": [],
                    "textvalue": [],
                    "price": 0,
                    "recurring_price": 0,
                    "setup": 0,
                    "prorata_date": null,
                    "items": [
                        {
                            "title": "512MB",
                            "value": 1,
                            "id": 10330,
                            "price": 0,
                            "setup": 0,
                            "selected": false
                        },
                        {
                            "title": "1GB",
                            "value": 1,
                            "id": 10331,
                            "price": 0,
                            "setup": 0,
                            "selected": false
                        },
                        {
                            "title": "2GB",
                            "value": 1,
                            "id": 10332,
                            "price": 0,
                            "setup": 0,
                            "selected": false
                        }
                    ]
                },
                (...)
            ],
            "addons": [
                {
                    "type": "subitem",
                    "title": "Cpanel2: Add Extra IP",
                    "id": "31",
                    "value": null,
                    "description": "Automatically adds IP address to account",
                    "config": [
                        {
                            "type": "checkbox",
                            "title": "add",
                            "name": "addon[31]",
                            "checked": false
                        },
                        {
                            "type": "select",
                            "title": "billingcycle",
                            "name": "addon_cycles[31]",
                            "items": [
                                {
                                    "title": "m",
                                    "value": "m",
                                    "price": 5,
                                    "setup": 0,
                                    "selected": true
                                },
                                {
                                    "title": "q",
                                    "value": "q",
                                    "price": 20,
                                    "setup": 0,
                                    "selected": false
                                },
                                {
                                    "title": "a",
                                    "value": "a",
                                    "price": 50,
                                    "setup": 0,
                                    "selected": false
                                }
                            ]
                        }
                    ],
                    "price": 0,
                    "recurring_price": 0,
                    "setup": 0,
                    "prorata_date": null
                },
                (...)
            ],
            "subproducts": []
        },
        "recurring_price": 9.99,
        "prorata_date": null
    }
}

HTTP Request

GET /order/@product_id

Query Parameters

Parameter	Type	Description
product_id	int	Product ID

Order new service

Create and submit new order for selected product.

To get available cycle and configuration options lookup product details using GET /order/@product_id

POST_DATA="{
    \"domain\": \"example.com\",
    \"cycle\": \"m\",
    \"pay_method\": \"1\",
    \"custom\": {
        \"1618\": {
            \"10330\": 1
        }
    },
    \"promocode\": \"T346F\",
    \"aff_id\": 55
}"

curl -X POST "https://vservs.com/client-area/api/order/@product_id" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "domain" => "example.com",
        "cycle" => "m",
        "pay_method" => "1",
        "custom" => [
            1618 => [
                10330 => 1
            ]
        ],
        "promocode" => "T346F",
        "aff_id" => 55
    ]
]);

$resp = $client->post('order/@product_id', $options);
echo $resp->getBody();

payload = {
    'domain': "example.com",
    'cycle': "m",
    'pay_method': "1",
    'custom': {
        '1618': {
            '10330': 1
        }
    },
    'promocode': "T346F",
    'aff_id': 55
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/order/@product_id', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "order_num": 873340995,
    "invoice_id": "308979",
    "total": "9.99",
    "items": {
        "id": "10",
        "type": "Hosting",
        "name": "test.com",
        "product_id": "3"
    }
}

HTTP Request

POST /order/@product_id

Query Parameters

Parameter	Type	Description
product_id	int	Product ID
domain	string	Domain name, ie. example.com, may be optional
cycle	string	Billing period symbol
pay_method	int	Payment method ID
custom	array	Additional options data available for sop products
promocode	string	Promotion code
aff_id	int	Affiliate ID

Order multiple services

Create and submit new order for multiple services

Each item in the items array needs to include order type and parameters used by one of the method listed below:
• POST /order/$product_id - use product for item type
• POST /domain/order - use domain for item type
• POST /certificate/order - use certificate for item type

POST_DATA="{
    \"pay_method\": 1,
    \"ignore_errors\": \"No error\",
    \"items\": [
        {
            \"type\": \"product\",
            \"product_id\": 1080,
            \"domain\": \"hosting.com\",
            \"cycle\": \"a\"
        },
        {
            \"type\": \"certificate\",
            \"product_id\": 840,
            \"csr\": \"-----BEGIN CERTIFICATE REQUEST----- (...)\",
            \"years\": 1,
            \"approver_email\": \"admin@hosting.com\"
        },
        {
            \"type\": \"domain\",
            \"tld_id\": 6,
            \"name\": \"hosting.com\",
            \"action\": \"register\",
            \"years\": 1
        },
        {
            \"type\": \"domain\",
            \"domain_id\": 1002,
            \"action\": \"renew\",
            \"years\": 1
        }
    ],
    \"aff_id\": 55
}"

curl -X POST "https://vservs.com/client-area/api/order" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "pay_method" => 1,
        "ignore_errors" => "No error",
        "items" => [
            [
                "type" => "product",
                "product_id" => 1080,
                "domain" => "hosting.com",
                "cycle" => "a"
            ],
            [
                "type" => "certificate",
                "product_id" => 840,
                "csr" => "-----BEGIN CERTIFICATE REQUEST----- (...)",
                "years" => 1,
                "approver_email" => "admin@hosting.com"
            ],
            [
                "type" => "domain",
                "tld_id" => 6,
                "name" => "hosting.com",
                "action" => "register",
                "years" => 1
            ],
            [
                "type" => "domain",
                "domain_id" => 1002,
                "action" => "renew",
                "years" => 1
            ]
        ],
        "aff_id" => 55
    ]
]
$resp = $client->post('order', $options);
echo $resp->getBody();

payload = {
    'pay_method': 1,
    'ignore_errors': "No error",
    'items': [
        {
            'type': "product",
            'product_id': 1080,
            'domain': "hosting.com",
            'cycle': "a"
        },
        {
            'type': "certificate",
            'product_id': 840,
            'csr': "-----BEGIN CERTIFICATE REQUEST----- (...)",
            'years': 1,
            'approver_email': "admin@hosting.com"
        },
        {
            'type': "domain",
            'tld_id': 6,
            'name': "hosting.com",
            'action': "register",
            'years': 1
        },
        {
            'type': "domain",
            'domain_id': 1002,
            'action': "renew",
            'years': 1
        }
    ],
    'aff_id': 55
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/order', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "order_num_list": [
        179534732,
        179534732,
        179534732
    ],
    "invoice_id": "503425",
    "total": "94.40",
    "items": [
        {
            "type": "Hosting",
            "id": "1025",
            "name": "hosting.com",
            "product_id": "1080"
        },
        {
            "type": "Hosting",
            "id": "1026",
            "name": "hosting.com",
            "product_id": "840"
        },
        {
            "type": "Domain Register",
            "id": "354",
            "name": "hosting.com",
            "product_id": "6"
        }
    ]
}

HTTP Request

POST /order

Query Parameters

Parameter	Type	Description
pay_method	int	Payment method ID
ignore_errors	bool	Process order even if some of the items were rejected due to errors
items	array	list with order items
aff_id	int	Affiliate ID

Get order quote

Calculate order cost and recurring prices for selected items. Use the same parameters as for POST /order

POST_DATA="{
    \"pay_method\": \"pay_methodValue\",
    \"output\": \"short\",
    \"items\": [
        {
            \"type\": \"product\",
            \"product_id\": 1080,
            \"domain\": \"hosting.com\",
            \"cycle\": \"a\"
        },
        {
            \"type\": \"certificate\",
            \"product_id\": 840,
            \"csr\": \"-----BEGIN CERTIFICATE REQUEST----- (...)\",
            \"years\": 1,
            \"approver_email\": \"admin@hosting.com\"
        },
        {
            \"type\": \"domain\",
            \"tld_id\": 6,
            \"name\": \"hosting.com\",
            \"action\": \"register\",
            \"years\": 1
        },
        {
            \"type\": \"domain\",
            \"domain_id\": 1002,
            \"action\": \"renew\",
            \"years\": 1
        }
    ]
}"

curl -X POST "https://vservs.com/client-area/api/quote" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "pay_method" => "pay_methodValue",
        "output" => "short",
        "items" => [
            [
                "type" => "product",
                "product_id" => 1080,
                "domain" => "hosting.com",
                "cycle" => "a"
            ],
            [
                "type" => "certificate",
                "product_id" => 840,
                "csr" => "-----BEGIN CERTIFICATE REQUEST----- (...)",
                "years" => 1,
                "approver_email" => "admin@hosting.com"
            ],
            [
                "type" => "domain",
                "tld_id" => 6,
                "name" => "hosting.com",
                "action" => "register",
                "years" => 1
            ],
            [
                "type" => "domain",
                "domain_id" => 1002,
                "action" => "renew",
                "years" => 1
            ]
        ]
    ]
]
$resp = $client->post('quote', $options);
echo $resp->getBody();

payload = {
    'pay_method': "pay_methodValue",
    'output': "short",
    'items': [
        {
            'type': "product",
            'product_id': 1080,
            'domain': "hosting.com",
            'cycle': "a"
        },
        {
            'type': "certificate",
            'product_id': 840,
            'csr': "-----BEGIN CERTIFICATE REQUEST----- (...)",
            'years': 1,
            'approver_email': "admin@hosting.com"
        },
        {
            'type': "domain",
            'tld_id': 6,
            'name': "hosting.com",
            'action': "register",
            'years': 1
        },
        {
            'type': "domain",
            'domain_id': 1002,
            'action': "renew",
            'years': 1
        }
    ]
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/quote', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "summary": {
        "subtotal": 72.2,
        "total": 88.81,
        "credit": 0,
        "discount": 0,
        "cost": 72.2,
        "recurring": [
            {
                "title": "Annually",
                "price": 81.18,
                "value": "a"
            },
            {
                "title": "Monthly",
                "price": 1.48,
                "value": "m"
            }
        ],
        "tax": [
            {
                "name": "VAT",
                "tax": 16.61,
                "value": 23
            }
        ]
    },
    "items": [
        {
            "product": {
                "id": 1080,
                "category_name": "SSL",
                "category_id": 69,
                "name": "GeoTrust QuickSSL Premium",
                "domain": "test.api",
                (...)
            },
            "domains": {
                (...)
            },
            "coupon": {},
            "index": 0,
            "valid": true,
            "info": [],
            "error": []
        },
        {
            "product": {
                "id": 840,
                "category_name": "Proxmox",
                "category_id": 19,
                "name": "VPS",
                "domain": "user.test.api",
                (...)
            },
            "domains": {
                (...)
            },
            "coupon": {},
            "index": 1,
            "valid": true,
            "info": [],
            "error": []
        },
        {
            "product": null,
            "domains": {
                "hosting.com": {
                    "id": 6,
                    "index": 0,
                    "category_id": "6",
                    "category_name": "Domains",
                    "name": "hosting.com",
                    "tld": ".com",
                    "period": 1,
                    "price": "12.00",
                    (...) 
                }
            },
            "coupon": {},
            "index": 2,
            "valid": true,
            "info": [],
            "error": []
        }
    ]
}

HTTP Request

POST /quote

Query Parameters

Parameter	Type	Description
pay_method	int	Payment method ID
output	string	Type of output, default is short. Possible options short - Basic details about the item in cart config- Basic details and form components full - All details available in cart
items	array	list with order items

DNS

List DNS

Returns a list of all DNS

curl -X GET "https://vservs.com/client-area/api/dns" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('dns');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/dns', auth=auth)
print(req.json())

Example Response:

{
    "service_ids": [
        "10",
        "20"
    ],
    "zones": [
        {
            "domain_id": "60",
            "name": "booble.com",
            "service_id": "10"
        },
        {
            "domain_id": "61",
            "name": "bgg12ooble.com",
            "service_id": "20"
        }
    ]
}

HTTP Request

GET /dns

Add DNS Zone

Creates a new DNS zone

POST_DATA="{
    \"name\": \"testzone.com\"
}"

curl -X POST "https://vservs.com/client-area/api/service/@service_id/dns" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "name" => "testzone.com"
    ]
]
$resp = $client->post('service/@service_id/dns', $options);
echo $resp->getBody();

payload = {
    'name': "testzone.com"
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/service/@service_id/dns', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "info": [
        "Domain zone testzone.com was created successfully."
    ]
}

HTTP Request

POST /service/@service_id/dns

Query Parameters

Parameter	Type	Description
service_id	int	Service ID
name	string	Zone name

List DNS for service

Returns a list of DNS zones under the service

curl -X GET "https://vservs.com/client-area/api/service/@service_id/dns" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('service/@service_id/dns');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/service/@service_id/dns', auth=auth)
print(req.json())

Example Response:

{
    "error": [
        "invalid method"
    ]
}

HTTP Request

GET /service/@service_id/dns

Query Parameters

Parameter	Type	Description
service_id	int	Service ID

Get DNS details

Returns details of the DNS zone

curl -X GET "https://vservs.com/client-area/api/service/@service_id/dns/@zone_id" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->get('service/@service_id/dns/@zone_id');
echo $resp->getBody();

auth=('username', 'password')

req = requests.get('https://vservs.com/client-area/api/service/@service_id/dns/@zone_id', auth=auth)
print(req.json())

Example Response:

{
    "service_id": 10,
    "name": "booble.com",
    "records": [
      {
        "id":"10",
        "name":"qwerty",
        "ttl":1800,
        "priority":0,
        "content":"127.0.0.1",
        "type":"A"
      },
      {
        "id":"11",
        "name":"qwerty",
        "ttl":1800,
        "priority":0,
        "content":"ns1.qwerty.com",
        "type":"NS"
      }
    ]
}

HTTP Request

GET /service/@service_id/dns/@zone_id

Query Parameters

Parameter	Type	Description
service_id	int	Service ID
zone_id	int	Zone ID

Remove DNS zone

Deletes the selected DNS zone

curl -X DELETE "https://vservs.com/client-area/api/service/@service_id/dns/@zone_id" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->delete('service/@service_id/dns/@zone_id');
echo $resp->getBody();

auth=('username', 'password')

req = requests.delete('https://vservs.com/client-area/api/service/@service_id/dns/@zone_id', auth=auth)
print(req.json())

Example Response:

{
   "info": [
     "Domain zone testzone.com was deleted successfully."
   ]
}

HTTP Request

DELETE /service/@service_id/dns/@zone_id

Query Parameters

Parameter	Type	Description
service_id	int	Service ID
zone_id	int	Zone ID

Add DNS Record

Creates a new record in the DNS zone

POST_DATA="{
    \"name\": \"example.com\",
    \"ttl\": 3600,
    \"priority\": 10,
    \"type\": \"A\",
    \"content\": \"192.168.1.2\"
}"

# OR ...

POST_DATA="{
    \"name\": \"_sip._tcp.example.com\",
    \"ttl\": 3600,
    \"priority\": 10,
    \"type\": \"SRV\",
    \"content\": [
        10,
        5060,
        \"vc01.example.com\"
    ]
}"

curl -X POST "https://vservs.com/client-area/api/service/@service_id/dns/@zone_id/records" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "name" => "example.com",
        "ttl" => 3600,
        "priority" => 10,
        "type" => "A",
        "content" => "192.168.1.2"
    ]
]);

// OR ...

$options = [
    'json' => [
        "name" => "_sip._tcp.example.com",
        "ttl" => 3600,
        "priority" => 10,
        "type" => "SRV",
        "content" => [
            10,
            5060,
            "vc01.example.com"
        ]
    ]
]);

$resp = $client->post('service/@service_id/dns/@zone_id/records', $options);
echo $resp->getBody();

payload = {
    'name': "example.com",
    'ttl': 3600,
    'priority': 10,
    'type': "A",
    'content': "192.168.1.2"
}

# OR ...

payload = {
    'name': "_sip._tcp.example.com",
    'ttl': 3600,
    'priority': 10,
    'type': "SRV",
    'content': [
        10,
        5060,
        "vc01.example.com"
    ]
}

auth=('username', 'password')

req = requests.post('https://vservs.com/client-area/api/service/@service_id/dns/@zone_id/records', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "record": {
      "name": "_sip._tcp.example.com",
      "type": "SRV",
      "ttl": "3600",
      "priority": "10",
      "content": [
        10,
        5060,
        "vc01.example.com"
      ]
    },
    "info": [
        "dnsnewrecordadded",
        "SRV"
    ]
}

HTTP Request

POST /service/@service_id/dns/@zone_id/records

Query Parameters

Parameter	Type	Description
service_id	int	Service ID
zone_id	int	Zone ID
name	string	Record name
ttl	int	Record ttl
priority	int	Priority of the record
type	string	Record type
content	string	Contents of the record

Edit DNS Record

Edits the selected DNS zone record

POST_DATA="{
    \"name\": \"example.com\",
    \"ttl\": 3600,
    \"priority\": 10,
    \"type\": \"A\",
    \"content\": \"192.168.1.2\"
}"

curl -X PUT "https://vservs.com/client-area/api/service/@service_id/dns/@zone_id/records/@record_id" \
   -u user:pass \
   -H "Content-Type: application/json" \
   -d "${POST_DATA}"

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);

$options = [
    'json' => [
        "name" => "example.com",
        "ttl" => 3600,
        "priority" => 10,
        "type" => "A",
        "content" => "192.168.1.2"
    ]
]
$resp = $client->put('service/@service_id/dns/@zone_id/records/@record_id', $options);
echo $resp->getBody();

payload = {
    'name': "example.com",
    'ttl': 3600,
    'priority': 10,
    'type': "A",
    'content': "192.168.1.2"
}

auth=('username', 'password')

req = requests.put('https://vservs.com/client-area/api/service/@service_id/dns/@zone_id/records/@record_id', json=payload, auth=auth)
print(req.json())

Example Response:

{
    "record": {
        "id": "55",
        "type": "A",
        "ttl": "3600",
        "name": "test",
        "priority": 0,
        "content": "192.168.1.2"
    },
    "info": [
        "The record was updated successfully."
    ]
}

HTTP Request

PUT /service/@service_id/dns/@zone_id/records/@record_id

Query Parameters

Parameter	Type	Description
service_id	int	Service ID
zone_id	int	Zone ID
record_id	int	Record ID
name	string	Record name
ttl	int	Record ttl
priority	int	Priority of the record
type	string	Record type
content	string	Contents of the record

Remove DNS Record

Removes the selected DNS zone record

curl -X DELETE "https://vservs.com/client-area/api/service/@service_id/dns/@zone_id/records/@record_id" \
   -u user:pass 

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://vservs.com/client-area/api/',
    'auth' => ['username', 'password']
]);


$resp = $client->delete('service/@service_id/dns/@zone_id/records/@record_id');
echo $resp->getBody();

auth=('username', 'password')

req = requests.delete('https://vservs.com/client-area/api/service/@service_id/dns/@zone_id/records/@record_id', auth=auth)
print(req.json())

HTTP Request

DELETE /service/@service_id/dns/@zone_id/records/@record_id

Query Parameters

Parameter	Type	Description
service_id	int	Service ID
zone_id	int	Zone ID
record_id	int	Record ID