Server Monitoring API Documentation
We aim to provide an easy to use RESTful HTTP-based API. The API is protected by SSL to ensure any of the information you send or receive is encrypted.
Authentication
To use any the API endpoints you will need to authenticate with your primary email address and password.
The authentication method used for interaction with the API is via HTTP Basic Authentication.
Authorization
The API will check your permissions and roles to ensure you are able to access various API endpoints. If you are not able to access and endpoint you should get an HTTP 403 error (we try to keep things legit).
Stateless
Any interaction with the API is stateless; this means that you need to provide any and all information required to complete a request (each request is a transaction).
Supported request method
The API supports requests (via HTTPS only) using either JSON, PHP (serialized data structures) or XML. To have a request (and a response) answered you should include format in your request as a suffix.
Supported response methods
While it is always advised to provide your requested response method we will always take your requested response method from your request (as per the supported request methods above).
API Limits
To ensure everyone gets a fair share we have API performance limitations in place, you are not able to request a maximum of 100 requests per minute with a maximum of 2,000 requests per 24 hours. This request level allows you to burst requests if you wish to execute batched work. We reserve the right to further restrict clients to ensure they don’t have a wider impact on customers.
Understanding the API
The API references a collection of “things” on a given customer account. Taking a few minutes to understand the following simple relationships will greatly help you integrate with the API in the way it's intended:
- Each customer account has system-wide unique Customer ID
- A customer account may have one or more servers associated with it, each server uses the server name as it’s unique identifier (server names are unique per customer account)
- Each server may have one or more services (or checks) associated with it, each check has its own unique Service ID. When managing services you will be required to provide the Service ID (for a number of actions you may be required to provide the server name that the service belongs to also)
- Each customer may have one or more contacts (or People) associated with it, each contact has a unique Contact ID. When managing a contact you will be required to provide the Contact ID
All of the API endpoints are accessible via the following “base” URL
https://api.sentinelmonitoring.com/1.0/
Dates and Times
Unless otherwise specified (with a time zone) dates and times will be returned as ISO8601 formatted dates and times including the timezone (generally offset against UTC).
Conventions
Throughout the documentation you will find the following conventions:
- #{text} : This should be substituted with the respective input value for the request
- … : Indicates a comment in the response to keep the response information clear. You will not see comments in live response data
Parameters
Red parameters indicate these parameters are required. Valid input parameter types are:
- String (a valid string of text)
- Email (a valid email address)
- Number (a valid positive number)
- List (or Array in many programming languages)
- Phone Number (a valid phone number without a prefix and must be numbers only)
- URL (a valid URL (including the respective page if applicable))
- Time zone (a valid time zone as described by the utility/timezones API endpoint)