API keys

People sign in to Netos with their own account. Scripts and integrations that call the Netos or NetBox API need a key instead. On Netos Cloud, API keys are issued and managed by Netos, not created by users.

What you need

  • What the script or integration does, and whether it only reads or also writes.
  • The environment it calls, for example https://uks001.app.netos.io/example/production/.
  • The person in your organization who owns it, and who Netos should contact about it.

AI assistants need no key

Claude, ChatGPT and Microsoft Copilot connect with your own sign-in, not a key. You sign in through your zone once and approve the connection; the assistant then works as you, with your permissions. See AI assistants.

Request a key

  1. Email [email protected] with the details above.
  2. Netos issues the key and tells you how to send it with each request.
  3. Store the key in your secret store. Never put it in a script, a ticket or an email thread.

Self-service personal API keys were removed from the zone. If you created one before, it no longer works through the zone: request a key from Netos instead.

The API access page

A gateway administrator sees API access in the zone menu, at https://<zone>.app.netos.io/_auth/access. It is read-only today and says that API keys are managed by Netos.

Removing a key

Keys are not checked against your company sign-in, so disabling a person in Okta or Entra does not revoke a key they asked for. When the owner leaves or the integration stops, ask Netos support to revoke the key.

Troubleshooting

What you see Likely cause Fix
401 with an old personal key Self-service personal keys no longer work through the zone Request a key from Netos
"Forbidden" on the API access page You are not a gateway administrator Ask your Netos administrator