Skip to main content

/api/v1/public/dashboard/

  • Updated

The StatusDashboard dashboard public API endpoint allows you to obtain status information for all services programmatically.  The dashboard API does not require authentication and can be used to embed status information into your existing websites, either with your own custom code, or using the StatusDashboard Dashboard Widget.

To enable the status dashboard public API 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.

status
integer

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

Output

Status

0

Operational
1

Active Scheduled Maintenance
2

Active Incident
3

Active Incident and Active Scheduled Maintenance

 

Authentication

The status dashboard public API endpoint supports authentication via inclusion of an API key in the HTTP header of requests to the API.  To enable authentication on the status dashboard public API 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.

 

Examples

Dashboard Status (List method, GET)

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

curl https://acme.statusdashboard.com/api/v1/public/dashboard/

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

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

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

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

curl -H "DB-AUTH-KEY: 1add9d1c2ae74ba7933bfe1fa1d3c275" https://acme.statusdashboard.com/api/v1/public/dashboard/

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

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

Related articles