# Health Check Extended

`Available on Agent 2.57.0 and above.` 

## Checks health status of services and users

> \_Available on Agent 2.57.0 and above.\_\
> \
> Returns the connectivity status of the Agent services (\*\*pod\*\*, \*\*key manager\*\* and \*\*datafeed\*\*) as well as users\
> connectivity (\*\*agentservice\*\* and \*\*ceservice\*\*).\
> \
> The global status will be set to \`DOWN\` if at least one of the sub-status is also \`DOWN\`.<br>

```json
{"openapi":"3.0.1","info":{"title":"Agent API","version":"25.8.1"},"servers":[{"url":"youragentURL.symphony.com/agent"}],"paths":{"/v3/health/extended":{"get":{"tags":["System"],"summary":"Checks health status of services and users","description":"_Available on Agent 2.57.0 and above._\n\nReturns the connectivity status of the Agent services (**pod**, **key manager** and **datafeed**) as well as users\nconnectivity (**agentservice** and **ceservice**).\n\nThe global status will be set to `DOWN` if at least one of the sub-status is also `DOWN`.\n","operationId":"v3ExtendedHealth","responses":{"200":{"description":"Agent is healthy, all components are `UP`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3Health"}}}},"503":{"description":"Agent is unhealthy, some components are `DOWN`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3Health"}}}}}}}},"components":{"schemas":{"V3Health":{"type":"object","properties":{"services":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/V3HealthComponent"}},"status":{"$ref":"#/components/schemas/V3HealthStatus"},"users":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/V3HealthComponent"}},"version":{"type":"string","description":"Required Agent verison"}}},"V3HealthComponent":{"type":"object","properties":{"authType":{"$ref":"#/components/schemas/V3HealthAuthType"},"message":{"type":"string","description":"An error message, if the component status is DOWN"},"status":{"$ref":"#/components/schemas/V3HealthStatus"},"version":{"type":"string","description":"Optional component version"}}},"V3HealthAuthType":{"type":"string","description":"Type of authentication","enum":["RSA","CERT"]},"V3HealthStatus":{"type":"string","description":"Application health status.","enum":["UP","DOWN"]}}}}
```

{% hint style="info" %}
📘 **Result Fields**

This API returns the connectivity status of the Agent services as well as users connectivity. The global status will be set to `DOWN` if at least one of the sub-status is also `DOWN`.\
\
**Agent services**: pod, key manager and datafeed.\
**User connectivity**: agentservice and ceservice
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://rest-api.symphony.com/main/info-health-check/health-check-extended-v3.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.