Share via

Health - Get

  • Reference
Service:
Status
API Version:
7.1-preview.1

Queries status information for the service all-up, or scoped to a particular service and/or geography

GET https://status.dev.azure.com/_apis/status/health?api-version=7.1-preview.1
With optional parameters: 
GET https://status.dev.azure.com/_apis/status/health?services={services}&geographies={geographies}&api-version=7.1-preview.1

URI Parameters

Name In Required Type Description
api-version
 query True

string

Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.
geographies
 query

string

array (string)

A comma-separated list of geographies for which to get status information for. Supported values: APAC, AU, BR, CA, EU, IN, UK, US.
services
 query

string

array (string)

A comma-separated list of services for which to get status information for. Supported values: Artifacts, Boards, Core services, Other services, Pipelines, Repos, Test Plans.

Responses

Name Type Description
200 OK

ServiceStatus

successful operation

Examples

Get service health
Get service health for one or more geographies
Get service health for one or more services
Get service health for one or more services and one or more geographies

Get service health

Sample request

GET https://status.dev.azure.com/_apis/status/health?api-version=7.1-preview.1

Sample response

Status code:
200 
{
  "status": {
    "health": "healthy",
    "message": "Everything is looking good"
  },
  "services": [
    {
      "id": "Core services",
      "geographies": [
        {
          "id": "US",
          "name": "United States",
          "health": "healthy"
        },
        {
          "id": "CA",
          "name": "Canada",
          "health": "healthy"
        },
        {
          "id": "BR",
          "name": "Brazil",
          "health": "healthy"
        },
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        },
        {
          "id": "UK",
          "name": "United Kingdom",
          "health": "healthy"
        },
        {
          "id": "APAC",
          "name": "Asia Pacific",
          "health": "healthy"
        },
        {
          "id": "AU",
          "name": "Australia",
          "health": "healthy"
        },
        {
          "id": "IN",
          "name": "India",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Boards",
      "geographies": [
        {
          "id": "US",
          "name": "United States",
          "health": "healthy"
        },
        {
          "id": "CA",
          "name": "Canada",
          "health": "healthy"
        },
        {
          "id": "BR",
          "name": "Brazil",
          "health": "healthy"
        },
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        },
        {
          "id": "UK",
          "name": "United Kingdom",
          "health": "healthy"
        },
        {
          "id": "APAC",
          "name": "Asia Pacific",
          "health": "healthy"
        },
        {
          "id": "AU",
          "name": "Australia",
          "health": "healthy"
        },
        {
          "id": "IN",
          "name": "India",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Repos",
      "geographies": [
        {
          "id": "US",
          "name": "United States",
          "health": "healthy"
        },
        {
          "id": "CA",
          "name": "Canada",
          "health": "healthy"
        },
        {
          "id": "BR",
          "name": "Brazil",
          "health": "healthy"
        },
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        },
        {
          "id": "UK",
          "name": "United Kingdom",
          "health": "healthy"
        },
        {
          "id": "APAC",
          "name": "Asia Pacific",
          "health": "healthy"
        },
        {
          "id": "AU",
          "name": "Australia",
          "health": "healthy"
        },
        {
          "id": "IN",
          "name": "India",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Pipelines",
      "geographies": [
        {
          "id": "US",
          "name": "United States",
          "health": "healthy"
        },
        {
          "id": "CA",
          "name": "Canada",
          "health": "healthy"
        },
        {
          "id": "BR",
          "name": "Brazil",
          "health": "healthy"
        },
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        },
        {
          "id": "UK",
          "name": "United Kingdom",
          "health": "healthy"
        },
        {
          "id": "APAC",
          "name": "Asia Pacific",
          "health": "healthy"
        },
        {
          "id": "AU",
          "name": "Australia",
          "health": "healthy"
        },
        {
          "id": "IN",
          "name": "India",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Test Plans",
      "geographies": [
        {
          "id": "US",
          "name": "United States",
          "health": "healthy"
        },
        {
          "id": "CA",
          "name": "Canada",
          "health": "healthy"
        },
        {
          "id": "BR",
          "name": "Brazil",
          "health": "healthy"
        },
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        },
        {
          "id": "UK",
          "name": "United Kingdom",
          "health": "healthy"
        },
        {
          "id": "APAC",
          "name": "Asia Pacific",
          "health": "healthy"
        },
        {
          "id": "AU",
          "name": "Australia",
          "health": "healthy"
        },
        {
          "id": "IN",
          "name": "India",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Artifacts",
      "geographies": [
        {
          "id": "US",
          "name": "United States",
          "health": "healthy"
        },
        {
          "id": "CA",
          "name": "Canada",
          "health": "healthy"
        },
        {
          "id": "BR",
          "name": "Brazil",
          "health": "healthy"
        },
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        },
        {
          "id": "UK",
          "name": "United Kingdom",
          "health": "healthy"
        },
        {
          "id": "APAC",
          "name": "Asia Pacific",
          "health": "healthy"
        },
        {
          "id": "AU",
          "name": "Australia",
          "health": "healthy"
        },
        {
          "id": "IN",
          "name": "India",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Other services",
      "geographies": [
        {
          "id": "US",
          "name": "United States",
          "health": "healthy"
        },
        {
          "id": "CA",
          "name": "Canada",
          "health": "healthy"
        },
        {
          "id": "BR",
          "name": "Brazil",
          "health": "healthy"
        },
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        },
        {
          "id": "UK",
          "name": "United Kingdom",
          "health": "healthy"
        },
        {
          "id": "APAC",
          "name": "Asia Pacific",
          "health": "healthy"
        },
        {
          "id": "AU",
          "name": "Australia",
          "health": "healthy"
        },
        {
          "id": "IN",
          "name": "India",
          "health": "healthy"
        }
      ]
    }
  ]
}

Get service health for one or more geographies

Sample request

GET https://status.dev.azure.com/_apis/status/health?geographies=EU&api-version=7.1-preview.1

Sample response

Status code:
200 
{
  "status": {
    "health": "healthy",
    "message": "Everything is looking good"
  },
  "services": [
    {
      "id": "Core services",
      "geographies": [
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Boards",
      "geographies": [
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Repos",
      "geographies": [
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Pipelines",
      "geographies": [
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Test Plans",
      "geographies": [
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Artifacts",
      "geographies": [
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Other services",
      "geographies": [
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        }
      ]
    }
  ]
}

Get service health for one or more services

Sample request

GET https://status.dev.azure.com/_apis/status/health?services=Pipelines&api-version=7.1-preview.1

Sample response

Status code:
200 
{
  "status": {
    "health": "healthy",
    "message": "Everything is looking good"
  },
  "services": [
    {
      "id": "Pipelines",
      "geographies": [
        {
          "id": "US",
          "name": "United States",
          "health": "healthy"
        },
        {
          "id": "CA",
          "name": "Canada",
          "health": "healthy"
        },
        {
          "id": "BR",
          "name": "Brazil",
          "health": "healthy"
        },
        {
          "id": "EU",
          "name": "Europe",
          "health": "healthy"
        },
        {
          "id": "UK",
          "name": "United Kingdom",
          "health": "healthy"
        },
        {
          "id": "APAC",
          "name": "Asia Pacific",
          "health": "healthy"
        },
        {
          "id": "AU",
          "name": "Australia",
          "health": "healthy"
        },
        {
          "id": "IN",
          "name": "India",
          "health": "healthy"
        }
      ]
    }
  ]
}

Get service health for one or more services and one or more geographies

Sample request

GET https://status.dev.azure.com/_apis/status/health?services=Boards,Pipelines&geographies=AU&api-version=7.1-preview.1

Sample response

Status code:
200 
{
  "status": {
    "health": "healthy",
    "message": "Everything is looking good"
  },
  "services": [
    {
      "id": "Boards",
      "geographies": [
        {
          "id": "AU",
          "name": "Australia",
          "health": "healthy"
        }
      ]
    },
    {
      "id": "Pipelines",
      "geographies": [
        {
          "id": "AU",
          "name": "Australia",
          "health": "healthy"
        }
      ]
    }
  ]
}

Definitions

Name Description
GeographyWithHealth
ScopeHealth
ServiceHealth
ServiceStatus
StatusSummary

GeographyWithHealth

Name Type Description
health

ScopeHealth

id

string

name

string

ScopeHealth

Name Type Description
advisory

string

degraded

string

healthy

string

unhealthy

string

unknown

string

ServiceHealth

Name Type Description
geographies

GeographyWithHealth[]

id

string

ServiceStatus

Name Type Description
lastUpdated

string

services

ServiceHealth[]

status

StatusSummary

StatusSummary

Name Type Description
health

ScopeHealth

message

string