Skip to main content
Service API keys let scripts and tools call FiveMesh service operations without using your dashboard session. Keys are user-owned. Scope controls whether the key targets personal resources or organization resources.

​
Create a key

1

Open key creation

In the dashboard, open Account and create a new API key.
2

Name the key

Use a name that describes where the key will run, such as Production CDN worker.
3

Choose the owner context

Select Personal resources or Organization resources.
4

Choose CDN path access

If the key has CDN permissions, choose whether it can access all CDN paths or only specific path prefixes.
5

Review permissions

Select a preset or customize the allowed service actions.
6

Copy the key

Create the key and copy the secret immediately.
The secret is shown once after creation. Store it in your deployment secrets or server environment before leaving the page.

​
Permission areas

The dashboard can create keys for:
  • Global service operations.
  • CDN operations such as read, write, delete, purge, domains and settings.
  • Cache operations such as resource cache, origins, rules, purge, preload and observability.
Use the smallest permission set that supports the script or tool.

​
CDN path prefixes

When a key has CDN permissions, you can restrict it to specific paths. Examples: 
/phone
/mugshots
/uploads
Use path scope when a script should only manage one media area.

​
Organization keys

For organization resources, choose the organization during key creation. The key remains owned by your user account, but the resource scope points at the selected organization.