Retrieves the health status of all the workers in the system.

Updated on Mar 20, 2026
Published on Jul 23, 2025

2 minute(s) reading time

Prev Next

Get

/api/v{version}/health

Security

OAuth

Authorization using OAuth2 with Client Credentials

FlowClient Credentials

Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize

Token URLhttps://identity.eu01.grassfish.com/connect/token

Header parameters

x-correlationToken

string

x-clientId

string

The external client ID for identifying the client.

Min length0

Max length128

x-onBehalfOf

string

Min length0

Max length24

api-version

string

Path parameters

version

stringRequired

Responses

200

Expand All

object

Provides some information about the health of a specific system or component.

success

object (Contracts.Common.Jsons.Common.SuccessJson)

boolean

message

string | null

unauthorizedAccess

boolean | null

notFound

boolean | null

correlationToken

string | null

errors

Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null

object

message

string | null

string

Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken", "CodeAlreadyTaken" ]

fieldName

string | null

isRequired

boolean | null

isOutOfRange

boolean | null

isTaken

boolean | null

errorCode

string | null

defaultDisplayMessage

string | null

errorCode

string | null

details

object (Contracts.Common.Jsons.Common.ErrorDetailsJson)

message

string | null

defaultDisplayMessage

string | null

status

string

The possible health statuses of a system or component.

Valid values[ "Healthy", "Unhealthy", "Degraded" ]

data

object | null

The additional data related to the health check.

property*

description

string | null

The description providing more details about the health check result.

401

Unauthorized

403

Forbidden

object

type

string | null

title

string | null

status

integer (int32) | null

detail

string | null

instance

string | null

property*

500

Internal Server Error

Documentation Index

Retrieves the health status of all the workers in the system.