> For the complete documentation index, see [llms.txt](https://rest-api.symphony.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rest-api.symphony.com/main/malware-scanner/customer-malware-scanner-apis/malware-scanner-health.md).

# Malware Scanner Health

## API to be implemented by the customer.

<mark style="color:blue;">`GET`</mark> `https://your-malware-scanner-domain.com/malware-scanner/v1/health`

Symproxy uses this API to check the health of the Malware Scanner.

#### Headers

| Name        | Type    | Description                                                                                                                                                                                                                                   |
| ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| X-Trace-Id  | string  | Trace ID that shall be returned back in header when updating the malware scan state for the file. This field is not required, being used for debugging purposes only.                                                                         |
| X-Ping-Scan | boolean | For diagnostic purposes only. If this header is set to true, the Malware Scanner shall not perform any scanning and just return HTTP 200 OK. This is required (mandatory) to check the connectivity between Symproxy and the Malware Scanner. |

#### Request Body

| Name                                      | Type   | Description                            |
| ----------------------------------------- | ------ | -------------------------------------- |
| content<mark style="color:red;">\*</mark> | string | Attachment body, binary string format. |

{% tabs %}
{% tab title="200: OK Result" %}

```javascript
//The response contains a single string message stating that the Malware Scanner is healthy and functioning properly.
```

{% endtab %}

{% tab title="400: Bad Request Result" %}

```javascript
//Bad request. See response body for further details.
```

{% endtab %}

{% tab title="500: Internal Server Error Result" %}

```javascript
//Server error. See response body for further details.
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://rest-api.symphony.com/main/malware-scanner/customer-malware-scanner-apis/malware-scanner-health.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.