Access and Authentication

Connection

Requests can be made using HTTP requests. The base URL for all available environments is listed below.

Production https://rp01.hostcontrol.com/api/v1
OTE https://rp.hostcontrol-ote.com/api/v1

Authentication

Authentication is done by using HTTP Basic authentication. This can be tested using CURL:

curl \
--request <method> \
--user "{{api_username}}:{{api_key}}" \
<url>

Requests

The REST API lets you interact from anything that can send an HTTP request using HTTP request methods.

Method Description
GET Get an object or an array of objects.
POST Create a new object.
PUT Update an object.
DELETE Delete an object.

JSON

All requests and responses are JSON formatted. For POST and PUT requests, the body of each request should be entirely JSON encoded. For details on JSON please visit http://json.org/ for more information.

Date formatting

Please note that the date format used in requests and responses is formatted using ISO-8601. Please see http://en.wikipedia.org/wiki/ISO_8601 for more information. All dates are in UTC.