> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.portreeve.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.portreeve.com/_mcp/server.

# Liveness and dependency check

GET https://api.portreeve.com/health

Unauthenticated and exempt from rate limiting. Returns 200 only if Postgres and Redis both answer within 500 ms; otherwise 503. Intended for load balancers and status monitoring, not for deciding whether to call for a verdict — use your SDK's `failMode` for that.

Reference: https://docs.portreeve.com/api-reference/operations/get-health

## Response

### 200

All dependencies answered within the budget.

- `status` ("ok", required) — Always `"ok"`. Anything other than a 200 means a dependency is down.

## Errors

### 503 Service Unavailable Error

A dependency (Postgres or Redis) did not answer within 500 ms.

- `error` (string, required) — **This is an open set.** New values ship without a new SDK release and without a breaking change, so this is documented as a plain string rather than a closed enum. Treat an unrecognised value as informational: log it, display it, never crash on it, and never map "unknown" to a punitive action. Publishing a closed enum here would make our next additive release break every generated client that validates responses. The values defined today (also available machine-readably in `x-portreeve-known-values`) are: `invalid_request`, `unauthorized`, `rate_limited`, `idempotency_conflict`, `conflict`, `not_found`, `internal`.
- `message` (string, required) — Human-readable, for your logs. Never show it to an end user — on a `block` it can describe what tripped.
- `details` (map from string to any, optional) — Optional structured context. On a 400 it carries `issues[]`, an array of `{ path, message }` — one entry per validation failure.

## Examples

**Response**

```json
{
  "status": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.portreeve.com/health"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.portreeve.com/health';
const options = {method: 'GET'};

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://api.portreeve.com/health"

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

	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://api.portreeve.com/health")

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

request = Net::HTTP::Get.new(url)

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://api.portreeve.com/health")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.portreeve.com/health');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.portreeve.com/health");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.portreeve.com/health")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```