NAV
Time4VPS
bash php python

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

To authorize, use this code:

# With bash, you can just pass the correct header with each request
                curl 'https://billing.time4vps.com/api' \
                  -u "username:password"
                
//We recommend to use Requests library available at https://github.com/rmccue/Requests
                require_once 'Requests.php';
                Requests::register_autoloader();

                $resp = Requests::get('https://billing.time4vps.com/api/details', array(), array(
                    'auth' => array('username', 'password')
                ));
                
# python requests module will handle basic authentication if provided with auth parameter
                import requests

                req = requests.get('https://billing.time4vps.com/api/details', auth=('username', 'password'))
                

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

This API uses Basic HTTP Authentication.

To authenticate with API with your client area access details (email address as username and your client area password).

All API calls requires authentication, API expects for the auth to be included in a header that looks like the following:

Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Clientarea

User Details

Return registration details for my account

curl "https://billing.time4vps.com/api/details" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/details', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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

curl "https://billing.time4vps.com/api/details" \
   -u user:pass \
   -d firstname="firstnameValue"\
   -d lastname="lastnameValue"\
   -d phonenumber="phonenumberValue"\
   -d vateu="vateuValue"\
   -d email="emailValue"\
   -d address1="address1Value"\
   -d companyname="companynameValue"\
   -d address2="address2Value"\
   -d city="cityValue"\
   -d state="stateValue"\
   -d postcode="postcodeValue"\
   -d country="countryValue"\
   -d type="typeValue"\
   -d multicheck="multicheckValue"\
   -d 2faenable="2faenableValue"\
   -d 2fasecret="2fasecretValue"
$data = array(
    'firstname' => 'firstnameValue',
    'lastname' => 'lastnameValue',
    'phonenumber' => 'phonenumberValue',
    'vateu' => 'vateuValue',
    'email' => 'emailValue',
    'address1' => 'address1Value',
    'companyname' => 'companynameValue',
    'address2' => 'address2Value',
    'city' => 'cityValue',
    'state' => 'stateValue',
    'postcode' => 'postcodeValue',
    'country' => 'countryValue',
    'type' => 'typeValue',
    'multicheck' => 'multicheckValue',
    '2faenable' => '2faenableValue',
    '2fasecret' => '2fasecretValue'
);
$resp = Requests::put('https://billing.time4vps.com/api/details', array(), $data, $options);
echo $resp->body;
payload = {
    'firstname' : 'firstnameValue',
    'lastname' : 'lastnameValue',
    'phonenumber' : 'phonenumberValue',
    'vateu' : 'vateuValue',
    'email' : 'emailValue',
    'address1' : 'address1Value',
    'companyname' : 'companynameValue',
    'address2' : 'address2Value',
    'city' : 'cityValue',
    'state' : 'stateValue',
    'postcode' : 'postcodeValue',
    'country' : 'countryValue',
    'type' : 'typeValue',
    'multicheck' : 'multicheckValue',
    '2faenable' : '2faenableValue',
    '2fasecret' : '2fasecretValue'
}
req = requests.put('https://billing.time4vps.com/api/details', data=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
firstname string First Name - First name
lastname string Last Name - Your family name
phonenumber string Phone
vateu string VAT ID
email string Email Address
address1 string Address 1 - Example description
companyname string Organization
address2 string Address 2
city string City
state string State
postcode string Post code
country string Country
type string Account Type
multicheck string Multi Check
2faenable string Two-Factor Authentication
2fasecret string Two-Factor Secret - If Two-Factor is enabled, enter 16-chars (letters/digits) secret code to use in Google Authenticator App.

List contacts

Return a list of contacts on this account

curl "https://billing.time4vps.com/api/contact" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/contact', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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

Query Parameters

Parameter Type Description
number int Ticket number

Add contact

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

curl "https://billing.time4vps.com/api/contact" \
   -u user:pass \
   -d firstname="firstnameValue"\
   -d lastname="lastnameValue"\
   -d phonenumber="phonenumberValue"\
   -d vateu="vateuValue"\
   -d email="emailValue"\
   -d address1="address1Value"\
   -d companyname="companynameValue"\
   -d address2="address2Value"\
   -d city="cityValue"\
   -d state="stateValue"\
   -d postcode="postcodeValue"\
   -d country="countryValue"\
   -d type="typeValue"\
   -d multicheck="multicheckValue"\
   -d 2faenable="2faenableValue"\
   -d 2fasecret="2fasecretValue"\
   -d password="passwordValue"\
   -d privileges[key]="privilegesValue"
$data = array(
    'firstname' => 'firstnameValue',
    'lastname' => 'lastnameValue',
    'phonenumber' => 'phonenumberValue',
    'vateu' => 'vateuValue',
    'email' => 'emailValue',
    'address1' => 'address1Value',
    'companyname' => 'companynameValue',
    'address2' => 'address2Value',
    'city' => 'cityValue',
    'state' => 'stateValue',
    'postcode' => 'postcodeValue',
    'country' => 'countryValue',
    'type' => 'typeValue',
    'multicheck' => 'multicheckValue',
    '2faenable' => '2faenableValue',
    '2fasecret' => '2fasecretValue',
    'password' => 'passwordValue',
    'privileges' => array('key'=>'value')
);
$resp = Requests::post('https://billing.time4vps.com/api/contact', array(), $data, $options);
echo $resp->body;
payload = {
    'firstname' : 'firstnameValue',
    'lastname' : 'lastnameValue',
    'phonenumber' : 'phonenumberValue',
    'vateu' : 'vateuValue',
    'email' : 'emailValue',
    'address1' : 'address1Value',
    'companyname' : 'companynameValue',
    'address2' : 'address2Value',
    'city' : 'cityValue',
    'state' : 'stateValue',
    'postcode' : 'postcodeValue',
    'country' : 'countryValue',
    'type' : 'typeValue',
    'multicheck' : 'multicheckValue',
    '2faenable' : '2faenableValue',
    '2fasecret' : '2fasecretValue',
    'password' : 'passwordValue',
    'privileges' : {'key':'value'}
}
req = requests.post('https://billing.time4vps.com/api/contact', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "contact_id": "1",        
    "info": [
        "profile_added"
    ]
}

HTTP Request

POST /contact

Query Parameters

Parameter Type Description
firstname string First Name - First name
lastname string Last Name - Your family name
phonenumber string Phone
vateu string VAT ID
email string Email Address
address1 string Address 1 - Example description
companyname string Organization
address2 string Address 2
city string City
state string State
postcode string Post code
country string Country
type string Account Type
multicheck string Multi Check
2faenable string Two-Factor Authentication
2fasecret string Two-Factor Secret - If Two-Factor is enabled, enter 16-chars (letters/digits) secret code to use in Google Authenticator App.
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

Contact privileges

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

curl "https://billing.time4vps.com/api/contact/privileges" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/contact/privileges', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/contact/@id" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/contact/@id', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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`

curl "https://billing.time4vps.com/api/contact/@id" \
   -u user:pass \
   -d firstname="firstnameValue"\
   -d lastname="lastnameValue"\
   -d phonenumber="phonenumberValue"\
   -d vateu="vateuValue"\
   -d email="emailValue"\
   -d address1="address1Value"\
   -d companyname="companynameValue"\
   -d address2="address2Value"\
   -d city="cityValue"\
   -d state="stateValue"\
   -d postcode="postcodeValue"\
   -d country="countryValue"\
   -d type="typeValue"\
   -d multicheck="multicheckValue"\
   -d 2faenable="2faenableValue"\
   -d 2fasecret="2fasecretValue"\
   -d privileges[key]="privilegesValue"
$data = array(
    'firstname' => 'firstnameValue',
    'lastname' => 'lastnameValue',
    'phonenumber' => 'phonenumberValue',
    'vateu' => 'vateuValue',
    'email' => 'emailValue',
    'address1' => 'address1Value',
    'companyname' => 'companynameValue',
    'address2' => 'address2Value',
    'city' => 'cityValue',
    'state' => 'stateValue',
    'postcode' => 'postcodeValue',
    'country' => 'countryValue',
    'type' => 'typeValue',
    'multicheck' => 'multicheckValue',
    '2faenable' => '2faenableValue',
    '2fasecret' => '2fasecretValue',
    'privileges' => array('key'=>'value')
);
$resp = Requests::put('https://billing.time4vps.com/api/contact/@id', array(), $data, $options);
echo $resp->body;
payload = {
    'firstname' : 'firstnameValue',
    'lastname' : 'lastnameValue',
    'phonenumber' : 'phonenumberValue',
    'vateu' : 'vateuValue',
    'email' : 'emailValue',
    'address1' : 'address1Value',
    'companyname' : 'companynameValue',
    'address2' : 'address2Value',
    'city' : 'cityValue',
    'state' : 'stateValue',
    'postcode' : 'postcodeValue',
    'country' : 'countryValue',
    'type' : 'typeValue',
    'multicheck' : 'multicheckValue',
    '2faenable' : '2faenableValue',
    '2fasecret' : '2fasecretValue',
    'privileges' : {'key':'value'}
}
req = requests.put('https://billing.time4vps.com/api/contact/@id', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "info": [
        "profile_updated"
    ]
}

HTTP Request

PUT /contact/@id

Query Parameters

Parameter Type Description
id int
firstname string First Name - First name
lastname string Last Name - Your family name
phonenumber string Phone
vateu string VAT ID
email string Email Address
address1 string Address 1 - Example description
companyname string Organization
address2 string Address 2
city string City
state string State
postcode string Post code
country string Country
type string Account Type
multicheck string Multi Check
2faenable string Two-Factor Authentication
2fasecret string Two-Factor Secret - If Two-Factor is enabled, enter 16-chars (letters/digits) secret code to use in Google Authenticator App.
privileges array Array with privileges that you want to enable. Formatted the same way as output from GET /contact/privileges

List portal notifications

Return a list of portal notifications.

curl "https://billing.time4vps.com/api/notifications" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/notifications', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 portal notifications

Return a list of portal notifications.

curl "https://billing.time4vps.com/api/notifications/new" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/notifications/new', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/notifications/@id/ack" \
   -u user:pass \
$data = array(
);
$resp = Requests::put('https://billing.time4vps.com/api/notifications/@id/ack', array(), $data, $options);
echo $resp->body;
payload = {
}
req = requests.put('https://billing.time4vps.com/api/notifications/@id/ack', data=payload, auth=auth)
print(req.json())

HTTP Request

PUT /notifications/@id/ack

Query Parameters

Parameter Type Description
id int

Billing

Account balance

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

curl "https://billing.time4vps.com/api/balance" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/balance', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/invoice" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/invoice', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/invoice/@id" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/invoice/@id', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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

Payment Methods

List available payment methods

curl "https://billing.time4vps.com/api/payment" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/payment', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/payment', auth=auth)
print(req.json())
Example Response:
{
    "payments": {
        "10": "BankTransfer",
        "9": "PayPal"
    }
}

HTTP Request

GET /payment

Support

List Tickets

List support tickets under my account

curl "https://billing.time4vps.com/api/tickets" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/tickets', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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"
        }
    ]
}

HTTP Request

GET /tickets

Ticket details

Get ticket details, including all replies

curl "https://billing.time4vps.com/api/tickets/@number" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/tickets/@number', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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

Services

List services

List all services under your account

curl "https://billing.time4vps.com/api/service" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/service', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/service/@id" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/service/@id', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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

Upgrade Options

List upgrade options

curl "https://billing.time4vps.com/api/service/@id/upgrade" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/service/@id/upgrade', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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
    }
}
curl "https://billing.time4vps.com/api/service/@id/upgrade" \
   -u user:pass \
   -d resources[key]="resourcesValue"\
   -d package="packageValue"\
   -d cycle="cycleValue"\
   -d send="sendValue"
$data = array(
    'resources' => array('key'=>'value'),
    'package' => 'packageValue',
    'cycle' => 'cycleValue',
    'send' => 'sendValue'
);
$resp = Requests::post('https://billing.time4vps.com/api/service/@id/upgrade', array(), $data, $options);
echo $resp->body;
payload = {
    'resources' : {'key':'value'},
    'package' : 'packageValue',
    'cycle' : 'cycleValue',
    'send' : 'sendValue'
}
req = requests.post('https://billing.time4vps.com/api/service/@id/upgrade', data=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

curl "https://billing.time4vps.com/api/service/@id/cancel" \
   -u user:pass \
   -d immediate="immediateValue"\
   -d reason="reasonValue"
$data = array(
    'immediate' => 'immediateValue',
    'reason' => 'reasonValue'
);
$resp = Requests::post('https://billing.time4vps.com/api/service/@id/cancel', array(), $data, $options);
echo $resp->body;
payload = {
    'immediate' : 'immediateValue',
    'reason' : 'reasonValue'
}
req = requests.post('https://billing.time4vps.com/api/service/@id/cancel', data=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 "https://billing.time4vps.com/api/service/@id/label" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/service/@id/label', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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

curl "https://billing.time4vps.com/api/service/@id/label" \
   -u user:pass \
   -d label="labelValue"
$data = array(
    'label' => 'labelValue'
);
$resp = Requests::post('https://billing.time4vps.com/api/service/@id/label', array(), $data, $options);
echo $resp->body;
payload = {
    'label' : 'labelValue'
}
req = requests.post('https://billing.time4vps.com/api/service/@id/label', data=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

Get service ID from Order Number

curl "https://billing.time4vps.com/api/service/order/@order_num" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/service/order/@order_num', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/service/order/@order_num', auth=auth)
print(req.json())
Example Response:
{
    "account_id": 925
}

HTTP Request

GET /service/order/@order_num

Query Parameters

Parameter Type Description
order_num int Order Number

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 "https://billing.time4vps.com/api/category" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/category', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/category/@category_id/product" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/category/@category_id/product', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/order/@product_id" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/order/@product_id', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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

For whitelabel server use 'serverhost.name' for a domain parameter.

curl "https://billing.time4vps.com/api/order/@product_id" \
   -u user:pass \
   -d domain="domainValue"\
   -d cycle="cycleValue"\
   -d pay_method="pay_methodValue"\
   -d custom[key]="customValue"
$data = array(
    'domain' => 'domainValue',
    'cycle' => 'cycleValue',
    'pay_method' => 'pay_methodValue',
    'custom' => array('key'=>'value')
);
$resp = Requests::post('https://billing.time4vps.com/api/order/@product_id', array(), $data, $options);
echo $resp->body;
payload = {
    'domain' : 'domainValue',
    'cycle' : 'cycleValue',
    'pay_method' : 'pay_methodValue',
    'custom' : {'key':'value'}
}
req = requests.post('https://billing.time4vps.com/api/order/@product_id', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "order_num": 873340995,
    "invoice_id": "308979",
    "total": "9.99"
}

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

Get available VPS products

List all available virtual private server products

curl "https://billing.time4vps.com/api/category/available/vps" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/category/available/vps', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/category/available/vps', auth=auth)
print(req.json())
Example Response:
[
    {
        "id": 0,
        "name": "Linux",
        "description": "
  • CPU: ...<\/li><\/ul>", "prices": [ "aaa" ], "components": [ "aaa" ], "addons": [ "aaa" ] } ]

HTTP Request

GET /category/available/vps

Order addon

Place order for addon to existing service

curl "https://billing.time4vps.com/api/service/@id/addon" \
   -u user:pass \
   -d addon_id="addon_idValue"
$data = array(
    'addon_id' => 'addon_idValue'
);
$resp = Requests::post('https://billing.time4vps.com/api/service/@id/addon', array(), $data, $options);
echo $resp->body;
payload = {
    'addon_id' : 'addon_idValue'
}
req = requests.post('https://billing.time4vps.com/api/service/@id/addon', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "id": 96
}

HTTP Request

POST /service/@id/addon

Query Parameters

Parameter Type Description
id int Service id
addon_id int Addon id

List all addons

List all ordered addons for existing service

curl "https://billing.time4vps.com/api/service/@id/addon" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/service/@id/addon', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/service/@id/addon', auth=auth)
print(req.json())
Example Response:
{
    "id": 45,
    "name": "Additional IP",
    "status": "Pending"
}

HTTP Request

GET /service/@id/addon

Query Parameters

Parameter Type Description
id int Service id

DNS

List DNS

Returns a list of all DNS

curl "https://billing.time4vps.com/api/dns" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/dns', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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

curl "https://billing.time4vps.com/api/service/@service_id/dns" \
   -u user:pass \
   -d name="nameValue"
$data = array(
    'name' => 'nameValue'
);
$resp = Requests::post('https://billing.time4vps.com/api/service/@service_id/dns', array(), $data, $options);
echo $resp->body;
payload = {
    'name' : 'nameValue'
}
req = requests.post('https://billing.time4vps.com/api/service/@service_id/dns', data=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 (example: testzone.com)

Get DNS details

Returns details of the DNS zone

curl "https://billing.time4vps.com/api/service/@service_id/dns/@zone_id" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/service/@service_id/dns/@zone_id', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/service/@service_id/dns/@zone_id" \
   -u user:pass 
$resp = Requests::delete('https://billing.time4vps.com/api/service/@service_id/dns/@zone_id', array(), $options);
echo $resp->body;
req = requests.delete('https://billing.time4vps.com/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

curl "https://billing.time4vps.com/api/service/@service_id/dns/@zone_id/records" \
   -u user:pass \
   -d name="nameValue"\
   -d ttl="ttlValue"\
   -d priority="priorityValue"\
   -d type="typeValue"\
   -d content="contentValue"
$data = array(
    'name' => 'nameValue',
    'ttl' => 'ttlValue',
    'priority' => 'priorityValue',
    'type' => 'typeValue',
    'content' => 'contentValue'
);
$resp = Requests::post('https://billing.time4vps.com/api/service/@service_id/dns/@zone_id/records', array(), $data, $options);
echo $resp->body;
payload = {
    'name' : 'nameValue',
    'ttl' : 'ttlValue',
    'priority' : 'priorityValue',
    'type' : 'typeValue',
    'content' : 'contentValue'
}
req = requests.post('https://billing.time4vps.com/api/service/@service_id/dns/@zone_id/records', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "info": [
        "Domain zone testzone.com was created successfully."
    ]
}

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 (example: 3600)
priority int Priority of the record
type string Record type (example: A)
content string Contents of the record (example: 192.168.1.2)

Edit DNS Record

Edits the selected DNS zone record

curl "https://billing.time4vps.com/api/service/@service_id/dns/@zone_id/records/@record_id" \
   -u user:pass \
   -d name="nameValue"\
   -d ttl="ttlValue"\
   -d priority="priorityValue"\
   -d type="typeValue"\
   -d content="contentValue"
$data = array(
    'name' => 'nameValue',
    'ttl' => 'ttlValue',
    'priority' => 'priorityValue',
    'type' => 'typeValue',
    'content' => 'contentValue'
);
$resp = Requests::put('https://billing.time4vps.com/api/service/@service_id/dns/@zone_id/records/@record_id', array(), $data, $options);
echo $resp->body;
payload = {
    'name' : 'nameValue',
    'ttl' : 'ttlValue',
    'priority' : 'priorityValue',
    'type' : 'typeValue',
    'content' : 'contentValue'
}
req = requests.put('https://billing.time4vps.com/api/service/@service_id/dns/@zone_id/records/@record_id', data=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 (example: 3600)
priority int Priority of the record
type string Record type (example: A)
content string Contents of the record (example: 192.168.1.2)

Remove DNS Record

Removes the selected DNS zone record

curl "https://billing.time4vps.com/api/service/@service_id/dns/@zone_id/records/@record_id" \
   -u user:pass 
$resp = Requests::delete('https://billing.time4vps.com/api/service/@service_id/dns/@zone_id/records/@record_id', array(), $options);
echo $resp->body;
req = requests.delete('https://billing.time4vps.com/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

SSL Certificates

List SSL Certificates

List all ssl services under your account

curl "https://billing.time4vps.com/api/certificate" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/certificate', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/certificate/@id" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/certificate/@id', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/certificate/@id/crt" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/certificate/@id/crt', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/certificate/@id/crt', auth=auth)
print(req.json())

HTTP Request

GET /certificate/@id/crt

Query Parameters

Parameter Type Description
id int Service id

Download CA Bundle

Return a bundle of X.509 certificates

curl "https://billing.time4vps.com/api/certificate/@id/ca" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/certificate/@id/ca', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/certificate/@id/ca', auth=auth)
print(req.json())

HTTP Request

GET /certificate/@id/ca

Query Parameters

Parameter Type Description
id int Service id

List available certificates

Return a list with certificate available for purchase

curl "https://billing.time4vps.com/api/certificate/order" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/certificate/order', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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 "https://billing.time4vps.com/api/certificate/order/@product_id/software" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/certificate/order/@product_id/software', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/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

curl "https://billing.time4vps.com/api/certificate/order" \
   -u user:pass \
   -d product_id="product_idValue"\
   -d csr="csrValue"\
   -d years="yearsValue"\
   -d pay_method="pay_methodValue"\
   -d approver_email="approver_emailValue"\
   -d admin="adminValue"\
   -d tech="techValue"\
   -d billing="billingValue"\
   -d organization[key]="organizationValue"\
   -d software="softwareValue"\
   -d data[key]="dataValue"
$data = array(
    'product_id' => 'product_idValue',
    'csr' => 'csrValue',
    'years' => 'yearsValue',
    'pay_method' => 'pay_methodValue',
    'approver_email' => 'approver_emailValue',
    'admin' => 'adminValue',
    'tech' => 'techValue',
    'billing' => 'billingValue',
    'organization' => array('key'=>'value'),
    'software' => 'softwareValue',
    'data' => array('key'=>'value')
);
$resp = Requests::post('https://billing.time4vps.com/api/certificate/order', array(), $data, $options);
echo $resp->body;
payload = {
    'product_id' : 'product_idValue',
    'csr' : 'csrValue',
    'years' : 'yearsValue',
    'pay_method' : 'pay_methodValue',
    'approver_email' : 'approver_emailValue',
    'admin' : 'adminValue',
    'tech' : 'techValue',
    'billing' : 'billingValue',
    'organization' : {'key':'value'},
    'software' : 'softwareValue',
    'data' : {'key':'value'}
}
req = requests.post('https://billing.time4vps.com/api/certificate/order', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "order_num": 873340994,
    "invoice_id": "308978",
    "total": "27.85"
}

HTTP Request

POST /certificate/order

Query Parameters

Parameter Type Description
product_id int Certificate product ID
csr string Domain name, ie. example.com
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

Server Management

Server management API lets you retrieve your active server information and manage them. All management tasks are asynchronous. This means called method will only initiate task and will return result of task initiation. If task initiation was unsuccessfull, error message will be returned. Task id is used to query Task Result method to retrieve task result. For more info see documentation of Task Result method.

For example to reboot server, you must initiate task by calling POST /server/@id/reboot. If task initiated successfully, you'll receive task_id parameter, which must be provided in GET /server/@server_id/task/@task_id call, to receive task results.

You can run one task per server at a time.

List All Servers

Lists all active servers. Results includes only the brief information about the server.

Call is synchronous - result returned immediately.

curl "https://billing.time4vps.com/api/server" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/server', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/server', auth=auth)
print(req.json())
Example Response:
{
    "server_id": 104,
    "domain": "server.domain.name",
    "date_created": "2017-01-31",
    "synch_date": "2017-01-31 15:35:00",
    "label": "Data Server",
    "type": "OpenVZ"
}

HTTP Request

GET /server

Server Details

Particular server details: configuration, installed OS, resource usage and etc.

Call is synchronous - result returned immediately.

curl "https://billing.time4vps.com/api/server/@server_id" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/server/@server_id', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/server/@server_id', auth=auth)
print(req.json())
Example Response:
{
    "synch_date": "2018-07-18T14:04:34+00:00",
    "domain": "server.domain.name",
    "label": "Data Server",
    "status": "Active",
    "cpu_frequency": 292,
    "cpu_cores": 1,
    "ram_limit": 137,
    "ram_used": 24,
    "disk_limit": 13613,
    "disk_usage": 145,
    "bw_limit": 4103,
    "bw_in": 97,
    "bw_out": 738,
    "os": "ubuntu-16.04-x86_64",
    "ip": "123.123.123.123",
    "additional_ip": [
        "124.124.124.124",
        "125.125.125.125"
    ],
    "dns_servers": null,
    "components": null,
    "active_task": null,
    "last_tasks": null
}

HTTP Request

GET /server/@server_id

Query Parameters

Parameter Type Description
server_id int Server ID

Task Result

Returns task result by given task ID, all dates are in ISO 8601 format:

Call is synchronous - result returned immediately.

curl "https://billing.time4vps.com/api/server/@server_id/task/@task_id" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/server/@server_id/task/@task_id', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/server/@server_id/task/@task_id', auth=auth)
print(req.json())
Example Response:
{
    "name": "server_reboot",
    "activated": "2018-05-31T10:25:24+00:00",
    "assigned": "2018-05-31T10:26:24+00:00",
    "completed": "2018-05-31T10:27:24+00:00",
    "results": "VM rebooted successfully"
}

HTTP Request

GET /server/@server_id/task/@task_id

Query Parameters

Parameter Type Description
server_id int Server ID
task_id int Task ID

Reboot

Call is asynchronous - task ID is returned.

curl "https://billing.time4vps.com/api/server/@server_id/reboot" \
   -u user:pass \
$data = array(
);
$resp = Requests::post('https://billing.time4vps.com/api/server/@server_id/reboot', array(), $data, $options);
echo $resp->body;
payload = {
}
req = requests.post('https://billing.time4vps.com/api/server/@server_id/reboot', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "task_id": 89371
}

HTTP Request

POST /server/@server_id/reboot

Query Parameters

Parameter Type Description
server_id int Server ID

Reinstall

Available OS'es can be obtained with GET /server/@server_id/oses call.

All data in the server will be lost! All of backups of your server will be deleted from our storages!

Call is asynchronous - task ID is returned.

curl "https://billing.time4vps.com/api/server/@server_id/reinstall" \
   -u user:pass \
   -d os="osValue"\
   -d script="scriptValue"\
   -d ssh_key="ssh_keyValue"
$data = array(
    'os' => 'osValue',
    'script' => 'scriptValue',
    'ssh_key' => 'ssh_keyValue'
);
$resp = Requests::post('https://billing.time4vps.com/api/server/@server_id/reinstall', array(), $data, $options);
echo $resp->body;
payload = {
    'os' : 'osValue',
    'script' : 'scriptValue',
    'ssh_key' : 'ssh_keyValue'
}
req = requests.post('https://billing.time4vps.com/api/server/@server_id/reinstall', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "task_id": 86731
}

HTTP Request

POST /server/@server_id/reinstall

Query Parameters

Parameter Type Description
server_id int Server ID
os string Operating System (required)
script int Init Script ID (optional)
ssh_key string SSH Key (optional)

Reset Password

Resets privileged user password

Call is asynchronous - task ID is returned.

curl "https://billing.time4vps.com/api/server/@server_id/resetpassword" \
   -u user:pass \
$data = array(
);
$resp = Requests::post('https://billing.time4vps.com/api/server/@server_id/resetpassword', array(), $data, $options);
echo $resp->body;
payload = {
}
req = requests.post('https://billing.time4vps.com/api/server/@server_id/resetpassword', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "task_id": 126464
}

HTTP Request

POST /server/@server_id/resetpassword

Query Parameters

Parameter Type Description
server_id int Server ID

Launch Web Console

Web Console should be used for emergency access only!

Call is asynchronous - task ID is returned.

curl "https://billing.time4vps.com/api/server/@server_id/webconsole" \
   -u user:pass \
   -d timeout="timeoutValue"\
   -d whitelabel="whitelabelValue"
$data = array(
    'timeout' => 'timeoutValue',
    'whitelabel' => 'whitelabelValue'
);
$resp = Requests::post('https://billing.time4vps.com/api/server/@server_id/webconsole', array(), $data, $options);
echo $resp->body;
payload = {
    'timeout' : 'timeoutValue',
    'whitelabel' : 'whitelabelValue'
}
req = requests.post('https://billing.time4vps.com/api/server/@server_id/webconsole', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "task_id": 119766
}

HTTP Request

POST /server/@server_id/webconsole

Query Parameters

Parameter Type Description
server_id int Server ID
timeout string Timeout in hours (required, valid values: '1h', '3h', '6h', '12h', '24h')
whitelabel bool Should result return white-labeled VNC host (required, valid values: 'true', 'false')

Change Hostname

Changes the hostname of your server. Hostname must pointed to your server main IP address.

Note: Full DNS record propagation can take up to 48 hours.

Call is asynchronous - task ID is returned.

curl "https://billing.time4vps.com/api/server/@server_id/rename" \
   -u user:pass \
   -d hostname="hostnameValue"
$data = array(
    'hostname' => 'hostnameValue'
);
$resp = Requests::post('https://billing.time4vps.com/api/server/@server_id/rename', array(), $data, $options);
echo $resp->body;
payload = {
    'hostname' : 'hostnameValue'
}
req = requests.post('https://billing.time4vps.com/api/server/@server_id/rename', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "task_id": 152182
}

HTTP Request

POST /server/@server_id/rename

Query Parameters

Parameter Type Description
server_id int Server ID
hostname string New hostname (required, must be pointed to server IP)

Change PTR Record

Changes PTR record for the additional IP (if server has more than one IPv4 address).

Call is asynchronous - task ID is returned.

curl "https://billing.time4vps.com/api/server/@server_id/changeptr" \
   -u user:pass \
   -d ip_address="ip_addressValue"\
   -d hostname="hostnameValue"
$data = array(
    'ip_address' => 'ip_addressValue',
    'hostname' => 'hostnameValue'
);
$resp = Requests::post('https://billing.time4vps.com/api/server/@server_id/changeptr', array(), $data, $options);
echo $resp->body;
payload = {
    'ip_address' : 'ip_addressValue',
    'hostname' : 'hostnameValue'
}
req = requests.post('https://billing.time4vps.com/api/server/@server_id/changeptr', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "task_id": 152103
}

HTTP Request

POST /server/@server_id/changeptr

Query Parameters

Parameter Type Description
server_id int Server ID
ip_address string IP Address to change PTR (required)
hostname string Hostname (required)

Flush IPTables / Firewall

Restores to defaults your server`s firewall settings.

Call is asynchronous - task ID is returned.

curl "https://billing.time4vps.com/api/server/@server_id/flushfirewall" \
   -u user:pass \
$data = array(
);
$resp = Requests::post('https://billing.time4vps.com/api/server/@server_id/flushfirewall', array(), $data, $options);
echo $resp->body;
payload = {
}
req = requests.post('https://billing.time4vps.com/api/server/@server_id/flushfirewall', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "task_id": 22336
}

HTTP Request

POST /server/@server_id/flushfirewall

Query Parameters

Parameter Type Description
server_id int Server ID

Change DNS Servers

Changes the DNS servers for your server.

At least 1 DNS servers muste be provided.

Call is asynchronous - task ID is returned.

curl "https://billing.time4vps.com/api/server/@server_id/changedns" \
   -u user:pass \
   -d ns1="ns1Value"\
   -d ns2="ns2Value"\
   -d ns3="ns3Value"\
   -d ns4="ns4Value"
$data = array(
    'ns1' => 'ns1Value',
    'ns2' => 'ns2Value',
    'ns3' => 'ns3Value',
    'ns4' => 'ns4Value'
);
$resp = Requests::post('https://billing.time4vps.com/api/server/@server_id/changedns', array(), $data, $options);
echo $resp->body;
payload = {
    'ns1' : 'ns1Value',
    'ns2' : 'ns2Value',
    'ns3' : 'ns3Value',
    'ns4' : 'ns4Value'
}
req = requests.post('https://billing.time4vps.com/api/server/@server_id/changedns', data=payload, auth=auth)
print(req.json())
Example Response:
{
    "task_id": 117111
}

HTTP Request

POST /server/@server_id/changedns

Query Parameters

Parameter Type Description
server_id int Server ID
ns1 string Nameserver 1 IP address (required)
ns2 string Nameserver 2 IP address (recommended)
ns3 string Nameserver 3 IP address (optional)
ns4 string Nameserver 4 IP address (optional)

Available OS List

List of available OS templates for a server.

Call is synchronous - result returned immediately.

curl "https://billing.time4vps.com/api/server/@server_id/oses" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/server/@server_id/oses', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/server/@server_id/oses', auth=auth)
print(req.json())
Example Response:
[
    {
        "os": "centos-7-x86_64",
        "title": "Centos 7"
    }
]

HTTP Request

GET /server/@server_id/oses

Query Parameters

Parameter Type Description
server_id int Server ID

Get additional IPs

List of additional IPs

Call is synchronous - result returned immediately.

curl "https://billing.time4vps.com/api/server/@server_id/ips" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/server/@server_id/ips', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/server/@server_id/ips', auth=auth)
print(req.json())
Example Response:
[
    {
        "ips": [
            "123.123.123.123",
            "124.124.124.124"
        ]
    }
]

HTTP Request

GET /server/@server_id/ips

Query Parameters

Parameter Type Description
server_id int Server ID

Get Usage Graphs

Image link is valid only for short period of time, around 5-10 minutes.

Images shows the graphics of the main resource usage (Daily, Weekly, Monthly..)

Call is synchronous - result returned immediately.

curl "https://billing.time4vps.com/api/server/@server_id/graphs/@width" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/server/@server_id/graphs/@width', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/server/@server_id/graphs/@width', auth=auth)
print(req.json())
Example Response:
[
    {
        "type": "cpu_daily",
        "url": "\/\/...\/graph.php?...VrBFovT0mOE0OZFwNrUf"
    }
]

HTTP Request

GET /server/@server_id/graphs/@width

Query Parameters

Parameter Type Description
server_id int Server ID
width int Image Width (min 200px, max 768px)

Get Usage History

Displays the bandwidth usage of a server.

Call is synchronous - result returned immediately.

curl "https://billing.time4vps.com/api/server/@server_id/history" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/server/@server_id/history', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/server/@server_id/history', auth=auth)
print(req.json())
Example Response:
[
    {
        "year": 0,
        "month": 0,
        "bw_in": 84,
        "bw_out": 15218,
        "quota_usage": 31996,
        "quota_limit": 40828,
        "inode_usage": 39940,
        "inode_limit": 76318
    }
]

HTTP Request

GET /server/@server_id/history

Query Parameters

Parameter Type Description
server_id int Server ID

Init Script Management

Get available init scripts

Script content is not included

curl "https://billing.time4vps.com/api/scripts" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/scripts', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/scripts', auth=auth)
print(req.json())
Example Response:
{
    "id": 710,
    "name": "My Init Script",
    "syntax": "python"
}

HTTP Request

GET /scripts

Get init script by ID

Script content is included

curl "https://billing.time4vps.com/api/scripts/@id" \
   -u user:pass 
$resp = Requests::get('https://billing.time4vps.com/api/scripts/@id', array(), $options);
echo $resp->body;
req = requests.get('https://billing.time4vps.com/api/scripts/@id', auth=auth)
print(req.json())
Example Response:
{
    "id": 4,
    "name": "My Init Script",
    "syntax": "python",
    "content": "import os..."
}

HTTP Request

GET /scripts/@id

Query Parameters

Parameter Type Description
id int Init Script ID