# Get instance operational status

GET https://app.unleash-instance.example.com/health

This operation returns information about whether this Unleash instance is healthy and ready to serve requests or not. Typically used by your deployment orchestrator (e.g. Kubernetes, Docker Swarm, Mesos, et al.).

Reference: https://docs.getunleash.io/api/get-health

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get instance operational status
  version: endpoint_operational.getHealth
paths:
  /health:
    get:
      operationId: get-health
      summary: Get instance operational status
      description: >-
        This operation returns information about whether this Unleash instance
        is healthy and ready to serve requests or not. Typically used by your
        deployment orchestrator (e.g. Kubernetes, Docker Swarm, Mesos, et al.).
      tags:
        - - subpackage_operational
      parameters:
        - name: Authorization
          in: header
          description: Header authentication of the form `undefined <token>`
          required: true
          schema:
            type: string
      responses:
        '200':
          description: healthCheckSchema
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthCheckSchema'
        '500':
          description: healthCheckSchema
          content: {}
components:
  schemas:
    HealthCheckSchemaHealth:
      type: string
      enum:
        - value: GOOD
        - value: BAD
    healthCheckSchema:
      type: object
      properties:
        health:
          $ref: '#/components/schemas/HealthCheckSchemaHealth'
          description: >-
            The state this Unleash instance is in. GOOD if the server is up and
            running. It never returns BAD, if the server is unhealthy you will
            get an unsuccessful http response.
      required:
        - health

```

## SDK Code Examples

```python
import requests

url = "https://app.unleash-instance.example.com/health"

headers = {"Authorization": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.unleash-instance.example.com/health';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.unleash-instance.example.com/health"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.unleash-instance.example.com/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.unleash-instance.example.com/health")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.unleash-instance.example.com/health', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.unleash-instance.example.com/health");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.unleash-instance.example.com/health")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```