# Health Check

If your Agent service is started and running properly, the status value will be `UP`.

`Available on Agent 2.57.0 and above.` 

## Checks health status

> \_Available on Agent 2.57.0 and above.\_\
> \
> Returns the connectivity status of your Agent server. If your Agent server is started and running, the status value will be \`UP\`<br>

```json
{"openapi":"3.0.1","info":{"title":"Agent API","version":"25.8.1"},"servers":[{"url":"youragentURL.symphony.com/agent"}],"paths":{"/v3/health":{"get":{"tags":["System"],"summary":"Checks health status","description":"_Available on Agent 2.57.0 and above._\n\nReturns the connectivity status of your Agent server. If your Agent server is started and running, the status value will be `UP`\n","operationId":"v3Health","responses":{"200":{"description":"Agent application is alive.","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"]}}}}
```


---

# 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-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.