> For the complete documentation index, see [llms.txt](https://help.form.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.form.io/admin/licensing/license-utilization-checks.md).

# License Utilization Checks

## License Utilization Requests

When deploying a Docker container or cloud-based environment with Form.io, it's essential to ensure outbound internet connectivity to the license validation endpoint:\
\
`license.form.io`

License server communication is outbound in nature and is required to validate your Form.io license and ensure correct platform functionality within the containerized environment. A failed connection to the license endpoint could result in a 'restricted' license state, removing some functionality from the portal or forms.

Certain API server requests will perform license checks prior to execution. These checks occur in two forms:

* **Cached checks** – performed against a locally cached license state.
* **Blocking checks** – require a real-time validation check to the license server.

### Cached License Utilization

These license checks are cached for a duration of 3 hours. Upon a cache miss, a [**blocking** **validation** **request**](#blocking-utilization-checks) is triggered. Within the cache window, subsequent license checks are performed in the background.

| Utilization Type   | Notes                                                                                                                                                                                                                                                                                         |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Submission Request | <ul><li>Listing Submissions</li><li>Creating Submissions</li><li>Patching Submissions</li><li>Updating Submissions</li><li>Retrieving Submission by ID</li></ul><p>Interacting with some pages in the portal use several of these requests in a single page load to display / modify data</p> |
| Form Request       | <ul><li>Retrieve Form</li><li>Retrieve form Draft</li></ul><p>Updating / Creating new forms does not incur a utilization</p>                                                                                                                                                                  |

### Blocking Utilization Checks

{% hint style="warning" %}
All other utilization checks are blocking in nature. They must receive a response from the license server before allowing the action to proceed.
{% endhint %}

This is a listing of portal routes, and relevant license utilization checks that may be made as part of it. Which checks are made depend on individual setup.

| Action                                                                          | Potential License Checks                                   |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| GET /project                                                                    | tenant \| stage                                            |
| GET /project/:projectId                                                         | formManager \| Accessibility \| project \| stage \| tenant |
| POST /project                                                                   | project \| stage \| tenant                                 |
| PUT /project/:projectId                                                         | project \| stage \| tenant                                 |
| DELETE /project/:projectId                                                      | project \| stage \| tenant                                 |
| GET /project/:projectId/manage                                                  | formManager                                                |
| POST /form                                                                      | form                                                       |
| <p>PUT /form/formId</p><p>PUT /form/:formId/draft</p><p>PATCH /form/:formId</p> | form                                                       |
| DELETE /form/:formId                                                            | form                                                       |


---

# 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://help.form.io/admin/licensing/license-utilization-checks.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.
