Learn how to enable, and configure API access for your instance
Full API endpoint documentation is available at api.kandji.io. This article walks through the steps of generating an API token within your Kandji instance.
The Kandji API is automatically available to customers Plan 500 or higher. The API is not enabled by default on new or existing instances. If you would like API access to be enabled for your instance, please contact support.
API access is available as an add-on for customers below Plan 500. See our pricing page for plan details.
API Rate Limit
The Kandji API currently has an API rate limit of 10,000 requests per hour per tenant.
Generate an API Token
Authentication to the Enterprise API is controlled via instance-level bearer tokens. To generate one:
- Log in and click on Settings.
- Click the Access tab.
- You can see your instance's specific API URL.
- Click the Add button to create a new API key.
- After clicking Add, provide a Name for your API token.
- Click Save.
- After saving the token name, a new modal will be shown providing you with the API token. Click the visibility symbol to expose it.
- Click the Copy button to copy the API token to your clipboard.
- Click Close after collecting the API token.
Modify an API Token
Once an API token has been created for an instance, you can modify its name or revoke it to prevent further access.
- Click the ellipsis next to the token.
- Clicking Rename will open the API Token Name modal shown previously. This will allow you to edit the name of the API token.
- Clicking Revoke will immediately invalidate the API token and prevent its further use. Once a token is revoked, it will no longer be shown in the list of API tokens for your instance.