Add events using our API

Configuration

These advanced events can be created only in an automated way via our API. The best way to use them is to incorporate a request to our API in your code deployment scripts (to do so by your agency) and in your configuration management tool (to do so by your provider).

20170317-code-deploy.png

Our API endpoint can be accessed via a simple HTTP request :

https://www.quanta-monitoring.com/api/events/push?type=<type>&content=<content>&auth_token=<token>

with the following parameters :

  • type: the type of the event :
    • "code_deploy": deployment code
    • "config_change": system configuration change
    • "comment": custom comment
    • "cron": any task than ran in background
    • "custom": whatever you need
  • content: the message associated with the event. This may be the version of the application or the changes made. You are free to use this field as you like.
  • auth_token: You must also specify an API token to authenticate the request. This token can be generated in the "Integrations" section of your site settings in QUANTA.


Examples

Using a POST :

curl -m 10 -X POST -d '{"type": "code_deploy", "content": "version 42.0"}' -H 'Content-Type: application/json' -H 'Authorization: Token 78e64233e09d3d8ec7bf73c4d9ea8a8851badbd216' https://www.quanta-monitoring.com/api/events/push 

Using a GET :

curl -m 10 https://www.quanta-monitoring.com/api/events/push?type=code_deploy&content="version 42.0"&auth_token=78e64233e09d3d8ec7bf73c4d9ea8a8851badbd216

 

Our API will send back an  HTTP 200 code if successful, and a 4xx or 5xx if there was an error. The response will contain a JSON content with the field "error" in case of error or "success" if successful.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.