All API requests should be made to the /api/0/ prefix, and will return JSON as the response:

curl -i

HTTP/1.0 200 OK
Date: Sat, 14 Feb 2015 18:47:20 GMT
Content-Type: application/json
Content-Language: en

{"version": "0"}

HTTP Verbs

Attlaz makes an attempt to stick to appropriate HTTP verbs, but we always prioritize usability over correctness.

DELETEUsed for deleting resources.
GETUsed for retrieving resources.
OPTIONSDescribes the given endpoint.
POSTUsed for creating resources.
PUTUsed for updating resources. Partial data is accepted where possible.

Parameters and Data

Any parameters not included in the URL should be encoded as JSON with a Content-Type of 'application/json':

curl -i \
-d '{"status": "resolved"}' \
-H 'Content-Type: application/json'

Additional parameters are sometimes specified via the querystring, even for POST, PUT, and DELETE requests:

curl -i \
-d '{"status": "resolved"}' \
-H 'Content-Type: application/json'

Full Swagger documentation:

Need more information?

As our platform is always evolving and is full customizable, it is not possible to provide all information here. Don't hesitate to reach out to our team if you have any questions or want more information about certain topics.