ServerStatus

Get the general health of Octopus Server.

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

get/serverstatus/health

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/serverstatus/health
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Response

A snapshot of the server or cluster's current health

Descriptionstring
Idstring

Gets or sets a unique identifier for this resource.

IsCompliantWithLicenseboolean
IsEntireClusterDrainingTasksboolean
IsEntireClusterReadOnlyboolean
IsOperatingNormallyboolean
LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Example response

{
  "Links": {
    "Self": "/api/..."
  }
}

Changes

No recorded changes to this operation across all 13 revisions of this API.