Introduction

The Garmingo Status API allows you to interact with the Garmingo Status platform programmatically.

You can use the API to retrieve information about monitors, incidents, events and more.
But also to create, update and delete monitors, incidents and events.

The API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

The base URL for the Garmingo Status API is https://garmingo.com/api/status/v1.

All other URLs are relative to this base URL. For example, the URL for the list of all monitors is https://garmingo.com/api/status/v1/monitors. The exact URL for each endpoint is documented in the reference section.

Authentication

To use the Garmingo Status API, you need to authenticate with an API key. To learn how to authenticate with an API key, see the Authentication documentation.

Rate Limiting

Some endpoints are rate limited to prevent abuse. The rate limit is dynamic and depends on the endpoint.

To avoid being rate limited, make sure to reduce the number of requests you make to the API to the minimum necessary.

Caching

Some endpoints are cached to improve performance. The cache duration is dynamic and depends on the endpoint.

But usually, the cache duration is between 0 and 5 minutes.

Errors

The Garmingo Status API uses standard HTTP response codes to indicate the success or failure of an API request.

Additionally, the API returns the success flag in the response body to indicate the success or failure of the request.
If the request was successful, the success flag is true. If the request failed, the success flag is false.
For failed requests there is also always a message field in the response body that contains a human-readable error message.