Document Version: v1.9.4

VPS.NET RESTful API Documentation

VPS Cloud Sites—Next Generation Web Hosting

This guide outlines the basic principles of using the VPS.NET RESTful API to manage your account and cloud servers. If you have any questions about using this system, please don't hesitate to contact the VPS.NET support team.

This documentation is program language-independent and our examples will use command-line CURL to send the requests to VPS.NET

Authentication
Requesting Data
API Functions:
- Cloud Servers
- Nodes
- IPs
- Backups
- Clouds
- DNS
- Support Tickets
- Templates
- Cloud Sites
- Domain Registration
- SSD VPS
- Invoices

GET Domains #

Gets the list of all registered domains on you account.

URL: https://api.vps.net/registered_domains.api10json
Method: GET
Returns: JSON array containing attributes for each domain on your account

Domain Check Availability #

Checks the availability of the specified domain name.

URL: https://api.vps.net/registered_domains/check_available.api10json
Method: POST
Accepts: JSON array containing parameters required to check domain availability - see below

	  {
                  "tlds": [ 'com', 'ca', 'us' ],
                  "domain_name": "yourdomain",
                  "suggestion": true
          }

Where:

tlds: Array of TLDs for which the domain name availability needs to be checked.
domain_name: Domain name that you need to check the availability for.
suggestion: Mention if domain name suggestions are required or not.

Returns: JSON array containing domain name availability (available/not available) status for the requested TLDs as well as domain name suggestions.

	  {
              "domains":
              {
                    "yourdomain.com": {"classkey": "domcno","status": "regthroughothers"},
                    "yourdomain.ca": {"classkey": "dotca","status": "available"},
                    "yourdomain.us": {"classkey": "domus","status": "regthroughothers"}
              },
              "suggestion":
              {
                    "SaveYourDomain": {"com": "notavailable","us": "available"},
                    "Your-Blog-Domain": {"com": "available","us": "available"},
                    "YourBlogDomain": {"com": "notavailable","us": "available"},
                    "ChooseYourDomain": {"com": "notavailable","us": "available"},
                    "RegisterYourDomain": {"com": "notavailable","us": "available"},
                    "Your-Domain-Names": {"com": "notavailable","us": "available"},
                    "Save-Your-Domain": {"com": "available","us": "available"},
                    "EnterYourDomain": {"com": "notavailable","us": "available"},
                    "Choose-Your-Domain": {"com": "notavailable","us": "available"},
                    "Your-Domain": {"com": "notavailable","us": "available"}
              }
          }

REGISTER Domain(s) #

URL: https://api.vps.net/registered_domains.api10json
Method: POST
Accepts: JSON array containing parameters required to register domain(s) - see below
Returns: JSON array containing status and description for the newly created domain(s)

	  {
		"domains":
                {
                    "yourdomain.com": "1",
                    "yourdomain.us": "1"
                },
                "auto_renew": 1,
                "protect_privacy": 1,
                "contact":
                {
                    "full_name": "Full Name",
                    "company": "VPS",
                    "email_address": "name@vps.net",
                    "address1": "your address",
                    "address2": "",
                    "address3": "",
                    "city": "Chicago",
                    "state": "Illinois",
                    "country": "US",
                    "zip_code": "50000",
                    "phone_code": "17",
                    "phone_number": "5006070"
		}
	  }

Where:

domains: Required. An array with domain name and number of years for which you wish to register
auto_renew: Required.
protect_privacy: Required.
contact: Required. Contact for the domain(s) using the details provided (see below).

Contact details:

full_name: Required. Name of the contact.
company: Required. Name of the company (Optional in case of .Eu Contact).
email_address: Required. Email address of the contact.
address1: Required. First line of address of the contact.
address2: Optional. Second line of address of the contact.
address3: Optional. Third line of address of the contact.
city: Required. Name of the City.
state: Optional. Name of the state.
country: Required. Country Code as per ISO 3166-1 alpha-2.
zip_code: Required. ZIP code.
phone_code: Required. Telephone number country code.
phone_number: Required. Telephone number.

Additional details depending on TLD:

US zone
"attr": "purpose"
Required. Mapping of the .US Nexus Application Purpose
- P1: Business use for profit.
- P2: Non-profit business, club, association, religious organization, etc.
- P3: Personal use.
- P4: Education purposes.
- P5: Government purposes.
"attr": "category"
Required. Mapping of the .US Nexus Category.
- C11: A natural person who is a United States citizen.
- C12: A natural person who is a permanent resident of the United States of America, or any of its possessions or territories.
- C21: A US-based organization or company (A US-based organization or company formed within one of the fifty (50) U.S. states, the District of Columbia, or any of the United States possessions or territories, or organized or otherwise constituted under the laws of a state of the United States of America, the District of Columbia or any of its possessions or territories or a U.S. federal, state, or local government entity or a political subdivision thereof).
- C31: A foreign entity or organization (A foreign entity or organization that has a bona fide presence in the United States of America or any of its possessions or territories who regularly engages in lawful activities (sales of goods or services or other business, commercial or non-commercial, including not-for-profit relations in the United States)).
- C32: Entity has an office or other facility in the United States.
```
	  {
		"domains":
                {
                    "yourdomain.com": "1",
                    "yourdomain.us": "1"
                },
                "auto_renew": 1,
                "protect_privacy": 1,
                "contact":
                {
                    "full_name": "Full Name",
                    "company": "VPS",
                    "email_address": "name@vps.net",
                    "address1": "your address",
                    "address2": "",
                    "address3": "",
                    "city": "Chicago",
                    "state": "Illinois",
                    "country": "US",
                    "zip_code": "50000",
                    "phone_code": "17",
                    "phone_number": "5006070",
                    "attr":
                    {
                        "purpose": "P1",
                        "category": "C12"
                    }
		}
	  }
```
CA zone
"ca": "CPR"
Required. Three-letter CPR code mentioned below
- CCO: Corporation (Canada or Canadian province or territory). Non-individual
- CCT: Canadian citizen. Individual
- RES: Permanent Resident of Canada. Individual
- GOV: Government or government entity in Canada. Non-individual
- EDU: Canadian Educational institution. Non-individual
- ASS: Canadian Unincorporated Association. Non-individual
- HOP: Canadian Hospital. Non-individual
- PRT: Partnership Registered in Canada. Non-individual
- TDM: Trade-mark registered in Canada (by a non-Canadian owner). Non-individual
- TRD: Canadian Trade union. Non-individual
- PLT: Canadian Political party. Non-individual
- LAM: Canadian Library, Archive or Museum. Non-individual
- TRS: Trust established in Canada. Non-individual
- ABO: Aboriginal Peoples (individuals or groups) indigenous to Canada. Individual
- INB: Indian Band recognized by the Indian Act of Canada. Non-individual
- LGR: Legal Representative of a Canadian Citizen or Permanent Resident. Individual
- OMK: Official mark registered in Canada. Non-individual
- MAJ: Her Majesty the Queen. Non-individual
"ca": "agree"

Required. '1' indicating that the Registrant has agreed to the .CA Registrant Agreement
```
	  {
		"domains":
                {
                    "yourdomain.com": "1",
                    "yourdomain.ca": "1"
                },
                "auto_renew": 1,
                "protect_privacy": 1,
                "contact":
                {
                    "full_name": "Full Name",
                    "company": "VPS",
                    "email_address": "name@vps.net",
                    "address1": "your address",
                    "address2": "",
                    "address3": "",
                    "city": "Chicago",
                    "state": "Illinois",
                    "country": "US",
                    "zip_code": "50000",
                    "phone_code": "17",
                    "phone_number": "5006070",
                    "ca":
                    {
                        "CPR": "PLT",
                        "agree": 1
                    }
		}
	  }
```

TRANSFER Domain #

URL: https://api.vps.net/transfer.api10json
Method: POST
Accepts: JSON array containing parameters required to transfer domain - see below
Returns: JSON array containing status and description for transfered domain

	  {
		"domain": "yourdomain.com",
                "auth_code": "domain_secret_code",
                "auto_renew": 1,
                "protect_privacy": 1,
                "contact":
                {
                    "full_name": "Full Name",
                    "company": "VPS",
                    "email_address": "name@vps.net",
                    "address1": "your address",
                    "address2": "",
                    "address3": "",
                    "city": "Chicago",
                    "state": "Illinois",
                    "country": "US",
                    "zip_code": "50000",
                    "phone_code": "17",
                    "phone_number": "5006070"
		}
	  }

Where:

domain: Required. A domain name you wish to transfer
auth_code: Required. Authorization Code (a.k.a. Domain Secret) of the domain name that you want to transfer
auto_renew: Required.
protect_privacy: Required.
contact: Required. Contact for the domain(s) using the details provided (see above).

GET properties for a Domain #

URL: https://api.vps.net/registered_domains/{ID}.api10json
Method: GET
Returns: single JSON object as outlined above

See above for example output and field definitions

UPDATE contact for a Domain #

URL: https://api.vps.net/registered_domains/{ID}/contacts/{CONTACT_TYPE}?format=api10json
Method: PUT
Returns: a 200 OK status with no content on success or a 422 Unprocessable Entity header with error message when fails.

	  {
            "contact":
                {
                    "full_name": "Full Name",
                    "company": "VPS",
                    "email_address": "name@vps.net",
                    "address1": "your address",
                    "address2": "",
                    "address3": "",
                    "city": "Chicago",
                    "state": "Illinois",
                    "country": "US",
                    "zip_code": "50000",
                    "phone_code": "17",
                    "phone_number": "5006070"
		}
	  }

Where:

{CONTACT_TYPE}: Required. A type of contact: registrant (Registrant Details), admin (Admin Details), tech (Technical Details) or billing (Billing Details)

RENEW Domain #

URL: https://api.vps.net/registered_domains/{ID}/renew.api10json
Method: PUT
Parameters: period Required. Number of years for which you want to Renew this domain.
Returns: a 200 OK status with no content on success or a 422 Unprocessable Entity header with error message when fails.

UPDATE Domain NS #

URL: https://api.vps.net/registered_domains/{ID}.api10json
Method: PUT
Returns: a 200 OK status with no content on success or a 422 Unprocessable Entity header with error message when fails.

	  {
            "ns":
                [
                    "dns1.vps.net",
                    "dns2.vps.net"
		]
	  }

SET Privacy Protection for a Domain #

URL: https://api.vps.net/registered_domains/{ID}.api10json
Method: PUT
Parameters: privacy_protection Required. True or false.
Returns: a 200 OK status with no content on success or a 422 Unprocessable Entity header with error message when fails.

SET Auto Renew for a Domain #

URL: https://api.vps.net/registered_domains/{ID}.api10json
Method: PUT
Parameters: auto_renew Required. True or false.
Returns: a 200 OK status with no content on success or a 422 Unprocessable Entity header with error message when fails.