API Access

API Access

Generate secure project tokens, expose your Content API endpoint, and control public availability.

API access API access

Project ID & Endpoint

FieldDescription
Project IDUUID identifying this project in every API request (project-id header).
Content API EndpointBase URL for REST calls — normally <your-domain>/api.

Click copy to put the value on your clipboard. JS SDK and MCP use this as baseUrl / ELMAPI_BASE_URL.

Public GET Toggle

Enable Public API to allow unauthenticated GET requests for content.

  • When ON: read is implied for public GET content endpoints.
  • When OFF: every request needs a project token with the right abilities.

POST/PUT/PATCH/DELETE always require a project token.
GET /api (project info) always requires a token with read — Public API does not open that route. Authentication JWTs cannot call it.

Access Tokens (project Sanctum)

These are project API tokens (not personal user keys, not Authentication end-user tokens).

ColumnDetails
NameFriendly label (e.g. “Gatsby Build”).
AbilitiesScopes granted to the token.
Edit / DeletePencil / Trash icons.

Creating a Token

  1. Click Create Token.
  2. Enter a name and tick Abilities:
    • read – GET endpoints (including GET /api)
    • create – POST / upload
    • update – PUT/PATCH, publish/unpublish/discard, versions mutate, link-translation
    • delete – DELETE
    • admin – collections/fields, project locales, webhooks admin API
    • introspectPOST /api/auth/api-keys/introspect for end-user uak_… keys
  3. Copy the token — you won’t see it again.

Authentication vs project tokens

CredentialUse for
Project Sanctum token (this page)CMS content, assets, schema, webhooks, MCP, server SDKs
Authentication JWTEnd-user identity only (/auth/*) — not CMS abilities
End-user uak_… keyYour app APIs via introspect — not CMS content routes

See Authentication.

Token Abilities Matrix

AbilityEndpoints allowed
readGET /api, collections, entries, assets, versions list/get
createCreate entries, upload assets, bulk create
updateUpdate/patch entries, publish/unpublish/discard-draft, version revert/label, link-translation, asset metadata
deleteDelete assets or content
adminCollection/field admin, locales, webhooks REST
introspectIntrospect end-user API keys

Permissions

AbilityNeeded for
access_api_access_settingsView tab, manage tokens, toggle public API

Best Practices

  • Use separate tokens for build servers, staging, and production.
  • Grant the least privileges needed.
  • Never put project tokens in browser bundles — use a BFF for authenticated CMS writes.
  • Rotate and delete unused tokens.

Search documentation

Find guides and reference pages