Skip to main content

/api/v1/public/service/impacted/

  • Updated

The impacted service public API endpoint allows you to obtain status information for all services that are currently being impacted by an active event, programmatically.  The endpoint does not require authentication (but does support it) and can be used for a variety of purposes, including embedding status information directly into your websites.

To enable the endpoint on a specific status dashboard, login to the StatusDashboard administration portal and navigate to Status Dashboards > Edit > Dashboard Options > API.

OUTPUT PARAMETERS
id
integer

The id of the service.

name
string

The name of the service.

description
string

The service description.

group
string

The service group.

status
integer

The current status of the service.  The possible options are:

Output

Status
1

Active Scheduled Maintenance
2

Active Incident
3

Active Incident and Active Scheduled Maintenance

 

Authentication

The endpoint supports authentication via inclusion of an API key in the HTTP header of requests to the API.  To enable authentication endpoint, login to the StatusDashboard administration portal and navigate to Status Dashboards > Edit > Dashboard Options > API > Authentication.  When authentication is enabled, you must include a header named Authorization with a value of the API key.

ETag Support

The endpoint recognizes the If-None-Match request header from clients. On every API response, the server will send an ETag response header which represents the version of data being sent. Clients can send this same value back to the server within the If-None-Match header indicating the version of data they currently have. If the client and server ETag value match (indicating that the client has the current data), then the server will send an HTTP204 No Content back to the client without sending the data.

Note: A more traditional HTTP304 Not Modified response would normally be expected in response to a matching ETag, however, due to certain restrictions, StatusDashboard sends an HTTP204 No Content response instead.

Examples

Service Status (List method, GET)

* Assumes a subdomain url of https://acme.statusdashboard.com

curl https://acme.statusdashboard.com/api/v1/public/service/impacted/

{
    "meta": {
        "limit": 100,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "description": "",
	    "group": "North America DataCenter",
            "id": 152,
            "name": "File Server",
            "status": 1
        },
        {
            "description": "http://owa.domain.com",
            "group": "North America DataCenter",
            "id": 151,
            "name": "Exchange Server",
            "status": 2
        }
    ]
}

Upon success, you'll receive back an HTTP 200 (OK) indicating that the API call succeeded.

Service Status (List method, GET, with authentication enabled)

* Assumes a subdomain url of https://acme.statusdashboard.com

curl -H "Authorization: 1add9d1c2ae74ba7933bfe1fa1d3c275" https://acme.statusdashboard.com/api/v1/public/service/impacted/

{
    "meta": {
        "limit": 100,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "description": "",
	    "group": "North America DataCenter",
            "id": 152,
            "name": "File Server",
            "status": 1
        },
        {
            "description": "http://owa.domain.com",
            "group": "North America DataCenter",
            "id": 151,
            "name": "Exchange Server",
            "status": 2
        }
    ]
}

Upon success, you'll receive back an HTTP 200 (OK) indicating that the API call succeeded.

Related articles