OpenBlu Basics

API Methods

Method NameAccess URIMethodsDescription
list_serversopenblu/v1/servers/listGETPOSTRetrieves all the available servers from OpenBlu
get_serveropenblu/v1/servers/getGETPOSTGets the details of an existing server by the server ID

API Authentication

OpenBlu's API is powered by Intellivoid API. This uses the standard "API Key" authentication method which is the same across all other Intellivoid APIs.
Hint: Your Access Key is your API Key
The following authentication methods are available
  • Basic HTTP Authentication
  • GET/POST Parameter

Basic HTTP Authentication

You can authenticate by providing your access key via the password field, the username can be left blank and you should not provide your access key via a username.

GET/POST Parameter

You can provide your access key via a GET Parameter or within a POST (multipart/form-data), the parameter name that is applicable to both methods is access_key, for example.

Security Notice

All official APIs by Intellivoid are done through api.intellivoid.net, followed by the service name and version of the API Handler. For example
Any unauthorized requests will result in a 401 Unauthorized response such as this
{
  "success": false,
  "response_code": 401,
  "error": {
    "error_code": 0,
    "type": "CLIENT",
    "message":
    "Unauthorized Access, Authentication is required"
  }
}
Additionally WWW-Authenticate: Basic realm="API Authentication" will be provided in the response headers, if you are using a web browser you will be prompted to authenticate, you can authenticate by providing your Access Key in the password field as explained above.

Troubleshooting

All API responses returns a X-Request-ID header with a unique value set with every response you get. It is important to log this request ID if you encounter unexpected issues and server-side errors. Intellivoid can use this ID to get more details about the request and troubleshoot the error.

Data protection

To protect your data, we do not store the information our server returns to your client, the only data we keep track of is the request data you sent and server-side details that are not visible in the request such as exception dumps, cache information and so on. This information is automatically deleted from our server after two weeks. This data is used to troubleshoot any problems with our services and to address them accordingly.