Skip to content

Document network requirements for licensing #751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
djigoio wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document network requirements for licensing #751

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9093dbd
Document network requirements for licensing
djigoio Jun 23, 2026
f43a660
Update network requirements and licensing notes
djigoio Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions content/licensing/1.overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,26 @@ If no license is configured, the instance runs on the core tier.

See the [General configuration](/configuration/general#license) reference for the full `LICENSE_KEY` and `LICENSE_TOKEN` environment variable details.

## Network Requirements

In online mode, Directus makes outbound HTTPS requests to `https://licensing.directus.com`. If your network restricts outbound traffic, allow the following endpoints:

@dstockton dstockton Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should be recommending allowing all endpoints so we can easily change/extend in the future.
OK to document these for completeness- but we should specify they are subject to future change

@djigoio djigoio Jun 24, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a notice under the table in the following commit 👍


| Method | Endpoint | Purpose |
| --- | --- | --- |
| `GET` | `/.well-known/jwks.json` | Token signature verification |
| `POST` | `/api/licenses/preview` | License preview before activation |
| `POST` | `/api/licenses/activate` | Initial license activation |
| `POST` | `/api/licenses/refresh` | Periodic license revalidation |
| `POST` | `/api/licenses/update` | Plan or addon changes |
| `POST` | `/api/licenses/deactivate` | License deactivation |
| `POST` | `/api/licenses/portal` | Opening the Stripe billing portal |
| `GET` | `/api/licenses/addons/options` | Fetching available addon options |
| `PATCH` | `/api/licenses/addons` | Purchasing or modifying addons |
| `DELETE` | `/api/licenses/addons` | Removing addons |

If outbound access to `https://licensing.directus.com` is not possible, use an [offline license token](#offline-mode) instead. Offline tokens are validated locally and require no outbound network access. Offline mode is only available on Enterprise plans.


## License Statuses

| Status | Meaning |
Expand Down
Loading