API Changelog

02/16/2015 (V5)

  • The new v5 API uses a different method for versioning. The old API took a version in the URL like http://wwws.appfirst.com/api/v4/servers/. The new API takes a version in the HTTP Accept header like “application/json; version=5″ and the URL for servers is be just http://wwws.appfirst.com/api/servers/ without a version in the URL.
  • The new API offers several return data formats that can be specified in the Accept header:
    • application/json; version=5
    • application/xml; version=5
    • application/yaml; version=5
  • The new API also has a web-browsable interface for convenience when developing. It is accessible at http://wwws.appfirst.com/api/dev/
    • Note that the /api/dev/ URL should only be used for development/testing and not in actual code as it will move to /api/ when v5 becomes the default version. Versions should be in the Accept header
  • The return fields and input fields have changed slightly for certain endpoints in order to standardize field names and provide a more consistent interface for users. Applications currently interacting with v4 of the API will probably need to be updated, but the changes required should not be too complicated. The new return formats can be seen on the web-browsable interface. Support documentation will be updated shortly.
  • There is a new Python client wrapper available at https://github.com/appfirst/afapi which makes integrating API calls into Python code much more convenient.
  • The new API v5 will become the default on February 16, 2015, at which point v3/v4 will be deprecated. Versions 3 & 4 will be shut off on March 16, 2015.

02/26/2014 (V4)

  • (All APIs) Introduce pagination in two forms: offset and cursor-based pagination. Additional documentation on the differences can be found in the pagination document.

04/03/2013 (V3)

  • (All APIs) If an endpoint is not specified a JSON formatted string will be returned containing available endpoints and allowed methods for that version. ‘all’ can be specified in place of a version.
  • (Servers) Attributes now include the latest version number of the AppFirst collector available for the server’s OS.

02/21/2013 (V3)

  • (Buckets) Now we allow customer to stream statsd data through our rest API instead of going through the collector. See bucket handler V3 for more details.

02/07/2013 (V3)

  • (Server Sets) Add Server Set list, update and create.
  • (Server Sets and Servers) Add the ability to auto detect applications on Server Set and individual server.

11/24/2012 (V3)

  • (API Deprecation) API version V3 is available for beta test now. All the previous version of APIs will be deprecated at the end of year 2012.
  • (All APIs) HttpResponse will be returned a JSON like format when there’s an error.
  • (All APIs) API requests will be limited by rate and size.
  • (All data request) When only ‘start date’ and ‘num’ are provided, ‘num’ points of data be retrieved from the start date.
  • (User Profiles) Add number of streaming collectors, total server, application, alerts, polled_data and log count of this user.

06/09/2012 (V2.1)

  • (Servers) Updated the server handler to include the OS distribution, architecture, and kernel version. Also created a new server tag API call that will read the server tags associated to a specific server and allow the user to update existing server tags to be linked to a specific server.
  • (Buckets) New feature of statsd includes status message. Now you can send status messages along with your udp messages and we will aggregate and store them in our database. The bucket API changes allow you to view these changes.
  • (Server Tags) Server tag now has two new calls. The first is a search API call that takes in a user-input text that is then searched for in our database. All server tags that match the pattern are returned in a list to the user. The second API call takes in a list of server tag names and returns all the distinct servers belonging to those server tags.

05/15/2012 (V2)

  • Changed the structure of the API handlers so that each one has the same version numbers. This means that the Log, Bucket, Application, etc. handlers will all be of the same latest version.
  • (Logs) – This version redirects the public API’s to our new backend infrastructure. As of right now version 1 of the Log public APIs will still work but it will no longer be functional as early as the next update. We highly recommend you make the switch to version 2.

04/30/2012 (V1)

  • Welcome to AppFirst’s new changelog page where we will document all of the changes to the API for upcoming versions.