The Xitoring REST API supports Bearer token authentication.

Bearer token authentication authorizes requests by passing a token in the header of each request. This approach eliminates the need for including a username and password in your application. Tokens can be revoked at any time.

Tokens can be administered within the account section of the Xitoring panel.

Example

This example uses token as the credential: --header Authorization: Bearer 999|dXNlcm5hbWU6cGFsohzgc3tgrh2nx3dvcmQ

The base URL establishes the API version in use. It serves as the foundation for every request made to the Xitoring REST API.

https://app.xitoring.com/api/v2

The Xitoring REST API supports the following HTTP methods:

Xitoring processes request data in both JSON formats.

For requests incorporating data in the request body, include the Content-Type attribute in the request header and set its value to application/json.

Example

Content-Type: application/json

For uploading files, the appropriate content type is multipart/form-data.

To prevent parsing errors in request data, consistently employ UTF-8 character encoding. Requests using alternative character encoding formats may lead to errors and may not be processed correctly.

Note: Parameter names are case-sensitive. For instance, appending "?checkId=..." to a query produces a different result than "?checkid=...". In general, an unrecognized parameter name (e.g., "checkid") is disregarded.

It is advisable to utilize a JSON parser for handling responses. This approach facilitates easy access to the response properties and allows your scripts to adapt to any new fields that may be introduced in the response in the future. (The addition of a new field to the response is not deemed a breaking change.)

Certain payloads or responses may include fields that lack documentation. These fields signify either experimental or deprecated information and are subject to modification. It is advisable to utilize only the documented parameters when making your requests.

Responses utilize standard HTTP response codes to indicate the success or failure of an operation. The subsequent table provides an overview of typical response codes returned by this API.