---
title: "Service status"
method: GET
path: "/v1/health"
tags: ["Partner API"]
---

# Service status

`GET /v1/health`

## Request

- Base URL: `https://sandbox.onlink.africa`
- URL: `https://sandbox.onlink.africa/v1/health`
- Auth: API key in header `X-OnLink-Key`

## Response `200`

Service is reachable

- PartnerHealthResponseDto
  - `status` 'ok', required: Always the exact string `ok`. Absolute, never hedged: if the plane is not serving you get an HTTP error, not a degraded value in this field.

## Other responses

- `401`: Signature missing or invalid

---

[API](https://skmtc.dev/onlink/apis/onlink-partner-api.md) - [All operations](https://skmtc.dev/onlink/apis/onlink-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/onlink/apis/onlink-partner-api/revisions/1d1c6a3671f2?raw)