---
title: "Web Service Health Status"
method: GET
path: "/health"
tags: ["Services"]
---

# Web Service Health Status

`GET /health`

Used to check the health status of the web service only

## Response `200`

OK

- HealthResponse — This API is invoked by monitoring tools, other services and infrastructure to retrieve health status the targeted service, this is unprotected method
  - `health` Health — object that describes health of the service
    - `healthCodeDescription` string — Human readable description
    - `healthCode` 'UNKNOWN' | 'OK' | 'UNDER_MAINTENANCE' | 'WARNING' | 'FAILED' — Enum that describes health of the service
    - `metaData` MetaData[]
      - `key` string
      - `value` string
  - `requestStatus` RequestStatus
    - `serverId` string
    - `statusCode` 'UNKNOWN' | 'SUCCESS' | 'UNAUTHORIZED' | 'PAYMENT_REQUIRED' | 'FORBIDDEN' | 'TIMEOUT' | 'EXISTS' | 'NOT_FOUND' | 'INTERNAL_ERROR' | 'INVALID_REQUEST' | 'INVALID_REQUEST_VERSION' | 'INVALID_REQUEST_DATA' | 'METHOD_NOT_ALLOWED' | 'CONFLICT' | 'UNPROCESSABLE_ENTITY' | 'TOO_MANY_REQUESTS' | 'INSUFFICIENT_STORAGE' | 'SERVICE_UNAVAILABLE' | 'PAYLOAD_TOO_LARGE' | 'NOT_ACCEPTABLE' | 'UNAVAILABLE_FOR_LEGAL_REASONS' | 'BAD_GATEWAY' — Describes response status reported by the server.
    - `statusDescription` string
    - `requestId` string

## Other responses

- `302` — Found
- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `404` — Not Found
- `405` — Method Not Allowed
- `409` — Object Exists
- `415` — Unsupported Media Type
- `422` — Unprocessable Entity
- `429` — Too Many Requests
- `451` — Unavailable For Legal Reasons
- `500` — Internal Error
- `501` — Not Implemented
- `502` — Bad Gateway
- `503` — Service Unavailable

---

[API](https://skmtc.net/brevdev/apis/ngc-api-documentation.md) · [All operations](https://skmtc.net/brevdev/apis/ngc-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brevdev/ngc-api-documentation/revisions/7f0aa99cc03e/schema)