---
title: "Preflight Tool APIs | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/preflight/web-api/"
---

# Preflight Tool APIs

> The Preflight Web API is a REST API that allows you to verify that users' print files are compatible with your printing equipment. You can [define preflight rules](https://customerscanvas.com/docs/on-premises/preflight/reference/rules.md) and check if print files match those rules by using HTTP requests.

The Preflight Web API allows you to:

-   [Upload files to the server](https://customerscanvas.com/docs/on-premises/preflight/web-api/upload.md)
-   [Download files from the server](https://customerscanvas.com/docs/on-premises/preflight/web-api/get.md)
-   [Check preflight rules](https://customerscanvas.com/docs/on-premises/preflight/web-api/check.md)
-   [Get the build info](https://customerscanvas.com/docs/on-premises/preflight/web-api/info.md)
-   [Save product state to Asset Storage](https://customerscanvas.com/docs/on-premises/preflight/web-api/save.md)

After you have deployed the Preflight Tool, you can navigate to `<your-instance-url>/swagger` and explore the interactive Web API in your browser. You can also [download a code sample](pathname:///files/PreflightWebApi.zip) demonstrating how to validate print files.

This Web API doesn't require authentication. In the examples of this section, we use the `appUrl` variable that represents a folder on your server where you deployed this tool, for example, **`http://example.com/pt/`**.
