---
title: "Retrieves the health status of all the workers in the system."
slug: "retrieves-the-health-status-of-all-the-workers-in-the-system-3"
updated: 2025-08-20T01:02:48Z
published: 2026-03-20T12:47:08Z
canonical: "docs.grassfish.com/retrieves-the-health-status-of-all-the-workers-in-the-system-3"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://docs.grassfish.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieves the health status of all the workers in the system.
Get/api/health
SecurityOAuth
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 parametersx-correlationTokenstring
x-clientIdstring
The external client ID for identifying the client.
Min length0Max length128
x-onBehalfOfstringMin length0Max length24
api-versionstring
Responses200
OK
Expand Allobject
Provides some information about the health of a specific system or component.
successobject (Contracts.Common.Jsons.Common.SuccessJson) okboolean
messagestring | null
unauthorizedAccessboolean | null
notFoundboolean | null
correlationTokenstring | null
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null object messagestring | null
idstring Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldNamestring | null
isRequiredboolean | null
isOutOfRangeboolean | null
isTakenboolean | null
errorCodestring | null
defaultDisplayMessagestring | null
errorCodestring | null
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson) messagestring | null
defaultDisplayMessagestring | null
statusstring
The possible health statuses of a system or component.
Valid values[
"Healthy",
"Unhealthy",
"Degraded"
]
dataobject | null
The additional data related to the health check.
property*
descriptionstring | null
The description providing more details about the health check result.
Expand Allobject
Provides some information about the health of a specific system or component.
successobject (Contracts.Common.Jsons.Common.SuccessJson) okboolean
messagestring | null
unauthorizedAccessboolean | null
notFoundboolean | null
correlationTokenstring | null
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null object messagestring | null
idstring Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldNamestring | null
isRequiredboolean | null
isOutOfRangeboolean | null
isTakenboolean | null
errorCodestring | null
defaultDisplayMessagestring | null
errorCodestring | null
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson) messagestring | null
defaultDisplayMessagestring | null
statusstring
The possible health statuses of a system or component.
Valid values[
"Healthy",
"Unhealthy",
"Degraded"
]
dataobject | null
The additional data related to the health check.
property*
descriptionstring | null
The description providing more details about the health check result.
Expand Allobject
Provides some information about the health of a specific system or component.
successobject (Contracts.Common.Jsons.Common.SuccessJson) okboolean
messagestring | null
unauthorizedAccessboolean | null
notFoundboolean | null
correlationTokenstring | null
errors Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null object messagestring | null
idstring Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldNamestring | null
isRequiredboolean | null
isOutOfRangeboolean | null
isTakenboolean | null
errorCodestring | null
defaultDisplayMessagestring | null
errorCodestring | null
detailsobject (Contracts.Common.Jsons.Common.ErrorDetailsJson) messagestring | null
defaultDisplayMessagestring | null
statusstring
The possible health statuses of a system or component.
Valid values[
"Healthy",
"Unhealthy",
"Degraded"
]
dataobject | null
The additional data related to the health check.
property*
descriptionstring | null
The description providing more details about the health check result.
401
Unauthorized
403
Forbidden
object typestring | null
titlestring | null
statusinteger (int32) | null
detailstring | null
instancestring | null
property*
object typestring | null
titlestring | null
statusinteger (int32) | null
detailstring | null
instancestring | null
property*
object typestring | null
titlestring | null
statusinteger (int32) | null
detailstring | null
instancestring | null
property*
500
Internal Server Error