Skip to main content
The Platform API uses scopes to define fine-grained access control. Scopes are selected when creating an API key.

How scopes work

Scope names follow a resource:action format (e.g. devices:read). Nearly all API endpoints require one or more scopes, shown on the endpoint’s API Reference page. If an API key is missing a required scope, the request returns 403 Forbidden.

Scope tiers

Most resources follow a common tier pattern: The write scope does not include read access—if you need both, select both scopes. Some resources have additional granular scopes beyond the standard tiers (e.g. deployments:stage). The manage scope always includes everything for the resource.

Scopes by resource

Config instances

Config schemas

Config types

Deployments

Devices

Git commits

Provisioning tokens

Releases

Principle of least privilege

While granting an API unrestricted access to your resources is convenient, it is a security risk. We recommend using the principle of least privilege to grant the least amount of access possible.
Last modified on May 13, 2026