> For the complete documentation index, see [llms.txt](https://docs.snyk.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snyk.io/platform-administration/snyk-broker/preflight-checks-for-snyk-broker.md).

# Preflight checks for Snyk Broker

How Snyk Broker preflight checks catch errors and misconfigurations at client startup

The main objective of preflight checks is to catch errors and misconfigurations early, on Broker Client startup, rather than later during use. Whether or not the checks are successful, the Broker Client starts. The following checks are available.

## `broker-server-status`

The Broker Server Healthcheck validates the connectivity to the Broker Server. It performs a GET request to `{BROKER_SERVER_URL}/healthcheck.`

If it is not specified, BROKER\_SERVER\_URL is [https://broker.snyk.io](https://broker.snyk.io/)

## `rest-api-status`

The REST API Healthcheck validates the connectivity to the Snyk REST API by performing a GET request to `{API_BASE_URL}/rest/openapi`. This check is conditional and will be executed only if high availability mode is enabled.

If it is not specified, the `API_BASE_URL` is [https://api.snyk.io](https://api.snyk.io/). For additional URLs, see [Regional hosting and data residency](https://docs.snyk.io/snyk-data-and-governance/regional-hosting-and-data-residency).

## `broker-client-url-validation`

The Broker Client Configuration Check validates the `BROKER_CLIENT_URL` value to the extent possible. The check verifies that the configuration contains a scheme (`http or https`) and if the scheme is `https`, that an SSL certificate+key is loaded or TLS-termination upstream is used.

If you are using TLS termination and you do not require a certificate+key in the Broker Client, add the environment variable `BROKER_CLIENT_URL_TLS_TERMINATED` to signal TLS termination in the preflight check.

There is no default.

{% hint style="info" %}
You can use the environment variable PREFLIGHT\_CHECKS\_ENABLED=false to disable the Preflight Checks feature, so no checks will be executed when the Broker Client starts.
{% endhint %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snyk.io/platform-administration/snyk-broker/preflight-checks-for-snyk-broker.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.