Simply API Documentation v
()
General information
- Order SimplyHosting Products
- Manage their orders
- Manage their servers
- Manage their IPs
- Manage their R1Soft Backup products
- Manage their clients (resellers only)
- Manage their private networks (via VLAN’s)
- Manage their support tickets
- Customer - anyone who wants to use our API to order products and manage them.
- Reseller - users who are reselling our products to their own customers and may require extended product list.
- Most requests are sent using POST method unless otherwise specified.
- api_key is a mandatory URL parameter required for all requests.
- Arguments for all requests must be sent as POST arguments.
- The Simply Hosting API only supports the JSON data serialisation format (i.e. the Content-Type and Accept headers are ignored)
Authentication
- User authenticates themselves using the /user/auth/ API request.
- Successful authentication provides a response with a hash, which is used as an authentication token.
- Subsequent API requests must include this authentication token (api_key)in subsequent API calls.
- User creates a secret key via the Simply Hosting portal (or alternatively, using the /user/generateSecretKey/ after successful portal account authentication).
- Subsequent API requests must include a generated authentication hash (i.e. a SHA256 hash of the secret key and timestamp) in subsequent API calls.
Synchronous and asynchronous responses
Response format
- All successful requests produce a HTTP 200 OK or HTTP 202 ACCEPTED status code.
- All unsuccessful (or partially successful) requests produce a HTTP 50x or HTTP 404 NOT FOUND status code.
- The HTTP response has the format below:
Error handling
- All unsuccessful (or partially successful) requests produce a HTTP 50x or HTTP 404 NOT FOUND status code.
- Partially successful requests throw a HTTP 50x for the first detected error.
- Partially successful requests provide more detailed error information in the status and errorMessage fields of the HTTP response body's responseType.
Implementation notes
Ordering Process
OS Installations
OS Installation can be carried out via the /server/install api.
You can only install the OS that you have requested when you purchased your server. If you wish to change to a different OS then you can do this by using the /server/upgrade API.
It’s also possible to specify the OS version you wish to install, but if you have an OS version that has reached its End of Life then you may need to install a later OS version (if a later version is supported). If there are no later versions available then you will need to raise a support ticket with our Support Team.
Partition Scheme
During OS installations (via /server/install), the Partition Scheme (partition_scheme) can be specified for a dedicated server Linux distribution . The partition scheme must be defined in JSON format and a example is shown below:
[
{
"mount": "/",
"size": 20,
"expand": 0
},
{
"mount": "swap",
"size": 16,
"expand": 0
},
{
"mount": "/home/partition",
"size": 250,
"expand": 1
}
]
If the partition_scheme is not specified, then by default it will be configured with an expandable root (i.e. ‘/‘) partition of at least 4GB and a swap partition of 32GB.