HTTP API

Common infos

The base URL for all requests is https://superv.gifff.cloud/api/v1/.

You always need to send a valid API key in the Authorization header.

The event endpoint

POST to /event

The endpoint accepts JSON (content-type: application/json) or URI-encoded query params (?job=example).

Required fields:

fieldexpected typedescription
job(string)A name that you decide to identify a job. It is shown on the dashboard.

Optional fields:

fieldexpected typedescription
id(string)An identifier to update the event by another request.
rows(number)If you want to save how many rows an event created.
size(number)If you want to save the size of a file for instance.
errors(string)Errors you want to save with the event.

Result

The endpoint does not return a response object, but only a 200 status code, if the request was successful.

Possible errors are 400 for missing fields, 403 for an invalid authorization, 429 for the rate limit or 500 for internal errors.

Limits

There is a rate limit of 120 events per hour.

Number fields are saved as big integers (8bytes) and can store -+9223372036854775807.

Request payload/body cannot be larger than 10KB.

Examples

Node.js with fetch:

123456789
fetch('https://superv.gifff.cloud/api/v1/event', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: 'xxxxxxxxx',
},
body: JSON.stringify({ job: 'backup.mysql' }),
});

Curl with query params:

1234
curl --request POST \
--url 'https://superv.gifff.cloud/api/v1/event?job=backup.mysql' \
--header 'Authorization: xxxxxxxx'

Curl sends a JSON body:

12345678
curl --request POST \
--url https://superv.gifff.cloud/api/v1/event \
--header 'Authorization: xxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
"job": "backup.mysql"
}'