Version 2 of our Read API
I'm happy to announce that we have released a new version of our Read API that you can use to get at your Honeybadger data. This new version includes performance improvements and new endpoints. Here's a list of what has changed since V1:
- All the endpoints that have pages now return a
linkselement in the json that can have up to three links:
prev. Self is the URL you just fetched, and is always present. The other two give you the next and previous pages of results, and they are omitted if we know there isn’t a previous or next page. You can get a next link that ends up having no results when fetched.
- The notices, and deploys endpoints now use the new paging params of
- There are no longer page counts or record counts in the list responses.
idtype has changed in the notice response, from an integer to a UUID.
team_idelement in the project response has been replaced with a
teamselement that is an array of hashes that contain the id and name of the teams associated with the project.
assigneeelement in the fault response has changed from a string (an email address) to an nested user object (id, name, email).
resolvedparams are no longer supported by the faults list. These filters have been replaced by the
qparam, which uses the same search syntax that we use in our UI.
- We added endpoints for sites, outages, and uptime checks. The outages and uptime checks endpoints use the
created_beforeparams for paging.
- The authentication method has been changed -- we now depend on HTTP Basic Auth rather than passing a token in the URL params.
- The API is now rate-limited.
When paging the notices, deploys, outages, and uptime checks endpoints,
you can pass a timestamp value (seconds since the epoch) in the
created_before params. This timestamp can be a
float in order to specify sub-second time resolution. For example,
since the notices endpoint is sorted by most recent notices first, if
the last result in the first page of notices that you get back from the
API has 2016-06-20T13:15:00.123456Z as the value for
can get the next page of results by including
created_before=1466428500.123456 in the params.
Out with the old, in with the new
With the launch of V2, we are officially deprecating V1. We'll keep V1 around until August 1st 2016, to give people a chance to move their applications to V2. After August 1st, we'll remove the V1 endpoints. Please note that this deprecation is only for the Read API -- there are no changes being made at this time to our Collector API that the notifiers use to send errors from your apps to us.
You can get all the details about interacting with the API at our documentation site. Enjoy!