Skip to main content
Every API request needs an API token in the x-api-key header.

​
Generating a token

  1. In the Ontoto Dashboard sidebar, open Developer → API Tokens.
  2. Click Create Token.
  3. Enter a name and optional description for the token.
  4. Set an expiry date.
  5. Choose an access scope.
  6. Click Create Token.
The dashboard shows the token value once, right after you create it. Copy it somewhere safe, because you cannot retrieve it again.

​
Access scopes

Tokens grant read-only access. Write access for programmatic device management may come later. Each token has one of two access modes.

​
All devices, groups, and sites

Grants read access to every device, device group, and site in your organisation.

​
Scoped access

Grants read access only to the resources you select, in any mix of these types: You cannot change a token’s permissions after you create it.

​
Managing tokens