API Stability Preview

The serviceStatus() GraphQL query will check the status for a specific typed service. This is a preview and subject to change.

Syntax

Below is the syntax for the serviceStatus() query field:

graphql
serviceStatus(
      serviceType: string!
   ): HealthStatus!

Below is an example using this query field:

Show:
graphql
query {
  serviceStatus(serviceType: "cool-service")
  {status, message}
}

Returned Datatype

For HealthStatus, there are a couple of parameters. They're listed here along with descriptions of each:

Table: HealthStatus

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 25, 2024
messagestringyes PreviewThe latest health status message from the service.
statusstringyes PreviewThe latest status from the service.