Skip to content

API keys

The API keys page manages API clients: OAuth2 client-credentials pairs that automation, SIEM and ITSM integrations, and scripts use to call the Airgate REST API. Each client gets exactly the permissions of one operator profile.

Settings › Administration › API keys lists every API client in the tenant. A toolbar filters the list:

Filter Meaning
Search name, client ID, description… Matches text in the name, client ID or description.
All scopes Shows only clients with the selected operator profile.
Status All, Enabled or Disabled, each with a count.
Any usage Used in the last 24 h, Idle for 90+ days or Never used.

Select a row to open the API client panel with its credentials, the permission matrix of its scope, a Quick start example and Recent activity from the audit log.

Column Meaning
Client Name and, below it, the description.
Client ID The OAuth2 client_id, with a copy button.
Scope (operator profile) The operator profile whose permissions the client receives.
Status Enabled or Disabled. A disabled client cannot obtain tokens.
Last token issued When the client last requested an access token, or Never.
Created Creation date.
Field Meaning
Name Required. For example ServiceNow integration.
Client ID Generated automatically as nac_ followed by random characters. Select Choose my own client ID to enter one: 3 to 128 characters, letters, digits, dot, dash and underscore. A client ID must be unique. It cannot be changed after creation.
Description Who owns the integration and what it does. Once set it cannot be cleared, only changed.
Scope (operator profile) Required. The client gets exactly the permissions of this profile. Profiles with permissions you do not hold cannot be selected, and Platform Administrator is never offered. See Administrators for the profiles.
Permissions of … Expand to see the permission matrix of the chosen scope.
Client enabled On by default.
Field Meaning
Client ID The client_id.
Client secret Never shown again; the secret is stored only as a hash.
Token endpoint https://<console host>/api/v1/oauth/token.
API base URL https://<console host>/api/v1/t/<tenant>.
Grant type client_credentials.
Token lifetime 1 hour.
Last token issued, Created Dates.

The Quick start block shows a curl example that requests a token and calls the API with Authorization: Bearer <token>. HTTP Basic client authentication is also accepted at the token endpoint.

Action What it does
Create API client Opens the form. Create & show secret creates the client and opens a one-time window with the Client ID, Client secret and a curl command to request a token.
Download credentials In the one-time window, downloads <client_id>.json with the name, client ID, client secret, token URL, API base URL and grant type.
Done Closes the one-time window. It is available only after you select I have copied the client secret to a secure place.
Edit Changes the name, description, scope or enabled state. Save changes sends only what changed. Changing the scope revokes every access token already issued to the client.
Rotate secret After confirmation, generates a new secret and shows it once. The old secret stops working immediately and every access token already issued to the client is revoked.
Disable After confirmation, revokes the client’s issued access tokens. No new tokens can be requested until the client is re-enabled.
Enable The client can request tokens again with its existing secret.
Delete After confirmation, removes the client. Integrations that use its credentials stop working immediately. Past actions stay in the audit log.
Audit trail Opens Audit log filtered on the client ID.
Refresh Reloads the list.
Bulk Enable, Disable, Delete Select rows, then choose an action. Clients whose scope has permissions you do not hold are skipped.
  • View: any role with admin:read: Tenant Administrator, Network Administrator, Read-only Administrator and Platform Administrator.
  • Change: admin:write: Tenant Administrator and Platform Administrator. You can grant only scopes whose permissions you hold yourself.
© 2026 Airowire Networks Pvt. Ltd. Airgate is a product of Airowire.Product · Release notes · Security