Services

The Service endpoint is used to get the current status of a service. Depending on your plan, you will have access via API to all the services available or just the services you monitor.

Get full list of services available

GET https://isdown.app/api/v2/services

Headers

Name	Type	Description
Authorization*	String	Bearer API_KEY

200: OK List of all the services

{
    "data": [
        {
            "id": "1",
            "type": "service",
            "attributes": {
                "name": "AWS",
                "urlname": "aws",
                "isdown_url": "https://isdown.app/integrations/aws"
            }
        },
        {
            "id": "55",
            "type": "service",
            "attributes": {
                "name": "Apple Developer",
                "urlname": "apple-developer",
                "isdown_url": "https://isdown.app/integrations/apple-developer"
            }
        },
        ...
    ]
n

The status of the services can be 'ok', 'minor', 'major', and 'maintenance'. It depends on the severity of the incidents and their impact on the service.

Try our demo services to see the examples' responses depending on the status. Here's the list of different demo services available for you to test. 'demo-service' - This service changes the status every 5 minutes, cycling between 'ok' and 'minor' or 'major'. 'demo-service-ok' - This service is always operational. 'demo-service-minor' - This service is always going through a minor outage. 'demo-service-major' - This service is constantly going through a major outage.

Get current status and incidents information of a service

GET https://isdown.app/api/v2/services/{service_name}

Path Parameters

Name	Type	Description
service_name*	String	Parameterize name for the service. Get the service_name from the url of a service. E.g., https://isdown.app/services/digitalocean it's digitalocean.

Headers

Name	Type	Description
Authorization*	String	Bearer API_KEY

200: OK When status is OK

{
    "data": {
        "id": "10000",
        "type": "service",
        "attributes": {
            "name": "Demo Service",
            "status": "ok",
            "status_page_url": "https://status.demo-service.com/",
            "isdown_url": "https://isdown.app/integrations/demo-service"
        }
    }
}

401: Unauthorized When authorization is missing or is invalid

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthorized access",
            "detail": "You are not authorized to access this resource"
        }
    ]
}

404: Not Found When we don't find the resource

{
    "errors": [
        {
            "status": 404,
            "title": "Resource not found",
            "detail": "The resource you are looking for does not exist"
        }
    ]
}

200: OK When status is any other than OK

{
    "data": {
        "id": "10000",
        "type": "service",
        "attributes": {
            "name": "Demo Service",
            "status": "major",
            "status_page_url": "https://status.demo-service.com/",
            "ongoing_incidents": {
                "data": [
                    {
                        "id": "10001",
                        "type": "incident",
                        "attributes": {
                            "url": "https://status.demo-service.com/incidents/10000",
                            "title": "Demo Incident 2",
                            "status": "minor",
                            "resolved": false,
                            "created_at": "2022-09-13T06:56:45.523+01:00",
                            "description": "This is a demo incident 2",
                            "resolved_at": "2022-09-13T07:26:45.523+01:00"
                        }
                    }
                ]
            },
            "isdown_url": "https://isdown.app/integrations/demo-service"
        }
    }
}