---
title: "Get the general health of Octopus Server."
method: GET
path: "/serverstatus/health"
tags: ["ServerStatus"]
---

# Get the general health of Octopus Server.

`GET /serverstatus/health`

Provides a super simple interface perfect for checking the general health of your entire Octopus Server cluster.

## Response `200`

A snapshot of the server or cluster's current health

- ServerStatusHealthResource
  - `Description` string
  - `Id` string — Gets or sets a unique identifier for this resource.
  - `IsCompliantWithLicense` boolean
  - `IsEntireClusterDrainingTasks` boolean
  - `IsEntireClusterReadOnly` boolean
  - `IsOperatingNormally` boolean
  - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
  - `Links` object — Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.
- `418` — Indicates that the server is not operating normally

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/revisions/b296c3a60aa5/schema)