---
title: "retrieve a status check by id"
method: GET
path: "/status-checks/{identifier}"
tags: ["health checks"]
---

# retrieve a status check by id

`GET /status-checks/{identifier}`

Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)

## Path parameters

- `identifier` string, required

## Query parameters

- `teamId` string, required

## Response `default`

default response

- StatusCheck
  - `teamId` string — The identifier of the team to which this status check belongs
  - `identifier` string — The identifier of this status check
  - `isContinuous` boolean — Is this status check continuous
  - `isPrivateNetwork` boolean — Is this status check executed in a private network
  - `endpointConfiguration` EndpointConfiguration
    - `url` string, url, required — The URL of the status check
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' — The method type of the status check
    - `headers` object — Optional request headers to be used when the status check is invoked
    - `payload` string — Payload for POST type of request
    - `headersArn` string — Optional request headers pulled from a remote AWS resource holding JSON-encoded key-values that make up the headers
  - `evaluationConfiguration` EvaluationConfiguration — The configuration for evaluating the success/failure of a status check
    - `okLatencyMaxMs` integer — The maximum latency in milliseconds for a successful status check
    - `okStatusCodes` string[], required — The list of successful response status codes for a successful status check
    - `responseBodyEvaluation` ResponseBodyEvaluation — The configuration for evaluating the success of a response body
      - `op` 'AND' | 'OR', required — The operation to logically combine predicates into a success or failure
      - `predicates` PredicateObject[], required — The list of predicates to evaluate against the status check response body
        - `comparator` HasCompareFunctionObject
        - `type` 'String' | 'Number' | 'Boolean', required — The type of primitive this predicate operates on
        - `jpQuery` string, required — The json path query to run to read from the response body
        - `rValue` object, required — The right hand value of the predicate
  - `rawEndpointConfiguration` EndpointConfiguration
    - `url` string, url, required — The URL of the status check
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' — The method type of the status check
    - `headers` object — Optional request headers to be used when the status check is invoked
    - `payload` string — Payload for POST type of request
    - `headersArn` string — Optional request headers pulled from a remote AWS resource holding JSON-encoded key-values that make up the headers
  - `name` string — The name of this status check
  - `description` string — The description of this status check
  - `thirdPartyPresets` string
  - `createdBy` string — The identifier of the user that created this status check
  - `createdAt` string, date-time — The time of creation of this status check
  - `updatedBy` string — The time of the most recent update for this status check (if applicable)
  - `updatedAt` string, date-time — The identifier of the user that most recently updated this status check (if applicable)
  - `teamExternalIntegration` TeamExternalIntegrationReference — Represents the configuration for referencing an external integration
    - `type` 'JIRA' | 'DATADOG' | 'DATADOG_EU' | 'DATADOG_US3' | 'DATADOG_US5' | 'DATADOG_US1_FED' | 'PAGERDUTY' | 'NEWRELIC' | 'GRAFANA' | 'DYNATRACE' | 'APPDYNAMICS' | 'PROMETHEUS' | 'CUSTOM' | 'K6' | 'LOAD_GENERATOR_CUSTOM' | 'AWS' | 'AZURE' | 'GCP' — The type of the external integration for the health check to be created/updated
    - `observabilityToolType` 'DATADOG' | 'PAGERDUTY' | 'NEWRELIC' | 'GRAFANA' | 'DYNATRACE' | 'APPDYNAMICS' | 'PROMETHEUS' | 'CUSTOM' | 'AWS' | 'AZURE' — The observability tool type of the external integration for the health check to be created/updated
    - `domain` string — The domain of the observability tool type of the external integration for the health check to be created/updated
    - `name` string, required — The name of the external integration for the health check to be created/updated
  - `pollingIntervalSeconds` integer — The frequency to poll in seconds, 15s to 60s inclusive
  - `requestParams` object — The request parameters for this status check
  - `multiSelectTags` object — The tags associated with this status check

## Other responses

- `401` — Authorization header missing or malformed. Please provide proper credentials in the authorization header.
- `403` — User requires privilege for target team: MINIMUM_TEAM_PRIVILEGES

---

[API](https://skmtc.net/gremlin/apis/gremlin-api.md) · [All operations](https://skmtc.net/gremlin/apis/gremlin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gremlin/gremlin-api/versions/70fe938a0b35/schema)