Mackerel API Documents (v0)

Summary

  • POST/PUT input should be JSON (application/json) valid against RFC. The success response is in JSON (application/json) as well.
  • X-Api-Key header (required): the API key of the organization to which targeted hosts and services belong.
    • You can see your API keys in the Dashboard.
    • Each API key's Read and Write permissions can be configured.
      • API keys that only have Read permission cannot be used for APIs that require Write permission.

Contents

Data types

  • Host ID <hostId>
    • This is a string that is provided by Mackerel when a host is registered. It is used to distinguish and identify each unique host the agent is running on.
  • Service name <serviceName>
    • This is the name of a service registered with Mackerel.

Update History

2016-03-31
Addition of Updating host roles API
2016-03-14
Addition of Get the information of the organization API
2015-12-15
Addition of List of users and Delete users APIs
2015-12-01
Addition of API specs for getting metrics
2015-11-12
Addition of Alert specifications
2015-10-05
Addition of Dashboard specifications.
2015-09-03
List of Services and List of Roles were added to API.
2015-08-28
Addition of description of API permissions.
2015-08-11
Change made to JSON format of monitor configuration connectivity monitoring.
2015-08-06
Addition of monitor configuration specs.
2015-05-20
Posting monitoring check reports added to API.
2014-11-25
Posting metrics added a description of metrics posting responses.
2014-07-24
Getting latest metrics added to API.
2014-07-03
Posting service metrics added to API.
2014-06-13
Retiring hosts added to API.
2014-05-21
added a `name` parameter to List of hosts.
2014-05-13
made correction where “POST” should have been “PUT” in Updating host information.

Need even more help?

Send us an email at support@mackerel.io. We'll get back to you right away.

Email Us

About

This is the page containing Mackerel's https://mackerel.io instructional documents.