---
title: "GET /health-check"
method: GET
path: "/health-check"
tags: ["Legal Hold Module"]
---

# GET /health-check

`GET /health-check`

## Request

- Base URL: `https://platform.relativity.com/Relativity.REST/api`
- URL: `https://platform.relativity.com/Relativity.REST/api/health-check`
- Auth: none declared. Required headers: `x-csrf-header`
- TypeScript: <https://skmtc.dev/relativity/apis/kcura-legalhold-services-v0/docs/health-check/get.ts> (a function with typed inputs; its response is checked against the schema)

[Internal] IPostDeployHealthCheckManager -

## Headers

- `x-csrf-header` string, required

## Response `200`

Successful Operation

- HttpResponseMessage
  - `Version` Version
    - `Major` integer
    - `Minor` integer
    - `Build` integer
    - `Revision` integer
    - `MajorRevision` Int16
    - `MinorRevision` Int16
  - `Content` HttpContent
    - `Headers` string[]
  - `StatusCode` 'Continue' | 'SwitchingProtocols' | 'OK' | 'Created' | 'Accepted' | 'NonAuthoritativeInformation' | 'NoContent' | 'ResetContent' | 'PartialContent' | 'MultipleChoices' | 'Ambiguous' | 'MovedPermanently' | 'Moved' | 'Found' | 'Redirect' | 'SeeOther' | 'RedirectMethod' | 'NotModified' | 'UseProxy' | 'Unused' | 'TemporaryRedirect' | 'RedirectKeepVerb' | 'BadRequest' | 'Unauthorized' | 'PaymentRequired' | 'Forbidden' | 'NotFound' | 'MethodNotAllowed' | 'NotAcceptable' | 'ProxyAuthenticationRequired' | 'RequestTimeout' | 'Conflict' | 'Gone' | 'LengthRequired' | 'PreconditionFailed' | 'RequestEntityTooLarge' | 'RequestUriTooLong' | 'UnsupportedMediaType' | 'RequestedRangeNotSatisfiable' | 'ExpectationFailed' | 'UpgradeRequired' | 'InternalServerError' | 'NotImplemented' | 'BadGateway' | 'ServiceUnavailable' | 'GatewayTimeout' | 'HttpVersionNotSupported'
  - `ReasonPhrase` string
  - `Headers` string[]
  - `RequestMessage` HttpRequestMessage
    - `Version` Version
      - `Major` integer
      - `Minor` integer
      - `Build` integer
      - `Revision` integer
      - `MajorRevision` Int16
      - `MinorRevision` Int16
    - `Content` HttpContent
      - `Headers` string[]
    - `Method` HttpMethod
      - `Get` HttpMethod (recursive)
      - `Put` HttpMethod (recursive)
      - `Post` HttpMethod (recursive)
      - `Delete` HttpMethod (recursive)
      - `Head` HttpMethod (recursive)
      - `Options` HttpMethod (recursive)
      - `Trace` HttpMethod (recursive)
      - `Method` string
    - `RequestUri` Uri
      - `AbsolutePath` string
      - `AbsoluteUri` string
      - `LocalPath` string
      - `Authority` string
      - `HostNameType` 'Unknown' | 'Basic' | 'Dns' | 'IPv4' | 'IPv6'
      - `IsDefaultPort` boolean
      - `IsFile` boolean
      - `IsLoopback` boolean
      - `PathAndQuery` string
      - `Segments` string[]
      - `IsUnc` boolean
      - `Host` string
      - `Port` integer
      - `Query` string
      - `Fragment` string
      - `Scheme` string
      - `OriginalString` string
      - `DnsSafeHost` string
      - `IdnHost` string
      - `IsAbsoluteUri` boolean
      - `UserEscaped` boolean
      - `UserInfo` string
    - `Headers` string[]
    - `Properties` object
  - `IsSuccessStatusCode` boolean

---

[API](https://skmtc.dev/relativity/apis/kcura-legalhold-services-v0.md) - [All operations](https://skmtc.dev/relativity/apis/kcura-legalhold-services-v0/llms.txt) - [OpenAPI document](https://skmtc.dev/relativity/apis/kcura-legalhold-services-v0/revisions/1c94d8855326?raw)