The Status API is a RESTful Endpoint that delivers the comprehensive service status, including details about individual service statuses and uptime, along with a list of past incidents, all in JSON format. You can refer to the CacheGenie Status Page as an example of the information that will be returned.
Table of Contents
Get Status Information
Returns the present overall service status, accompanied by a list of individual service uptimes (over the last 30 days) and their respective statuses, in addition to a record of past incidents. Authentication is not required for this API Endpoint.
GET | https://cachegenie.com/api/status
Response Parameters
- CODE (Integer): Represents the status code of the API Response.
- MESSAGE (String): A message that indicates the Response of the API Request.
- DATA (Object): Contains the data returns by the API Request.
- CURRENT_STATUS (Object): Contains the current status information.
- TITLE (String): Title of the current status.
- DESCRIPTION (String): A description of the status & any updates.
- TYPE (String): Indicates the type of status event (e.g. "System Maintenance").
- AFFECTED_SERVICES (Array): A list of services that are affected by the current status event.
- NAME (String): The name of the affected service.
- TIMESTAMP (String): Unix timestamp indicating the last update of the current status event.
- UPTIME_LAST_30_DAYS (Array): Contains a list of uptime statistics for different services (for the last 30 days).
- NAME (String): The name of the service.
- UPTIME_PERCENTAGE (String): Percentage uptime of the service in the last 30 days.
- STATUS (String): The current operational status of the service.
- PAST_INCIDENTS (Array): Contains a list of past incidents.
- TITLE (String): Title of the incident.
- DESCRIPTION (String): A description of the incident & any updates.
- TYPE (String): Indicates the type of status event (e.g. "System Maintenance").
- AFFECTED_SERVICES (Array): A list of services that are affected by the incident.
- NAME (String): The name of the affected service.
- TIMESTAMP (String): Unix timestamp indicating the last update of the incident.