API Reference

Response Codes

  • 200 (OK) - request good!
  • 302 (Found) - the root /, redirects to /heartbeat, and /docs redirects to these documents
  • 400 (Bad request) - When you have a malformed request, fix it and try again
  • 404 (Not found) - When you request a route that does not exist, fix it and try again
  • 405 (Method not allowed) - When you use a prohibited HTTP method (we only allow GET and HEAD)
  • 500 (Internal server error) - Server got itself in trouble; get in touch with us. (in Issues)

400 responses will look something like

HTTP/1.1 400 Bad Request
Cache-Control: public, must-revalidate, max-age=60
Connection: close
Content-Length: 61
Content-Type: application/json
Date: Thu, 26 Feb 2015 23:27:57 GMT
Server: nginx/1.7.9
Status: 400 Bad Request
X-Content-Type-Options: nosniff

{
    "error": "invalid request",
    "message": "maximum limit is 5000"
}

404 responses will look something like

HTTP/1.1 404 Not Found
Cache-Control: public, must-revalidate, max-age=60
Connection: close
Content-Length: 27
Content-Type: application/json
Date: Thu, 26 Feb 2015 23:27:16 GMT
Server: nginx/1.7.9
Status: 404 Not Found
X-Cascade: pass
X-Content-Type-Options: nosniff

{
    "error": "route not found"
}

405 responses will look something like (with an empty body)

HTTP/1.1 405 Method Not Allowed
Access-Control-Allow-Methods: HEAD, GET
Access-Control-Allow-Origin: *
Cache-Control: public, must-revalidate, max-age=60
Connection: close
Content-Length: 0
Content-Type: application/json; charset=utf8
Date: Mon, 27 Jul 2015 20:48:27 GMT
Server: nginx/1.9.3
Status: 405 Method Not Allowed
X-Content-Type-Options: nosniff

500 responses will look something like

HTTP/1.1 500 Internal Server Error
Cache-Control: public, must-revalidate, max-age=60
Connection: close
Content-Length: 24
Content-Type: application/json
Date: Thu, 26 Feb 2015 23:19:57 GMT
Server: nginx/1.7.9
Status: 500 Internal Server Error
X-Content-Type-Options: nosniff

{
    "error": "server error"
}

Occassionally you may get a MySQL error message in your error slot. Get in touch
with us if that happens as that shouldn't be happening, and we'll need to fix
something on our end.