ApexDiagramBeta

Create an API key

Keys carry a role and an expiry, can be limited to your addresses, and are shown once.

  1. Open your profile menu (top right) and choose API keys.
  2. Name the key after what will use it, for example CI pipeline or NetBox sync.
  3. Choose a role:
    • Viewer to read.
    • Editor to read and write.
    • Admin for more.
  4. Choose when it expires: 30 days, 90 days, 1 year or never.
  5. Optionally list the allowed addresses (IPs or ranges) it may be used from.
  6. Click create, then copy the key now. It's never shown again.

Send the key with every request as Authorization: Bearer ad_…. The same keys work for the REST API and the MCP server. See Is there an API?

Revoke a key on the same page as soon as you no longer need it. The list shows when each key was last used.

On the Free plan, you get one key and it's read-only. Read-write keys need Team.

Didn’t answer your question? Sign in to contact support or search the help centre.