Step 1: Generate API Key
Last updated
Last updated
The API key is essential as it authenticates your Jibril agent(s) with your Garnet Platform account. This allows the agents to securely send telemetry data to the platform and receive configurations.
There are two main ways to generate an API key. We recommend using the Onboarding Guide for the simplest setup.
This is the easiest way to get an API key with the minimal permissions required for agent operations. The Onboarding Guide will also walk you through the subsequent steps of setting up your agents.
Access the Onboarding Guide:
Log in to the Garnet Platform dashboard (typically https://dashboard.garnet.ai).
From any page in the dashboard, click on the "Onboarding Guide" button in the navigation menu.
Generate API Key via Onboarding:
The first step in the Onboarding Guide is typically "API Token."
The guide will present an option to generate an API key specifically for agent use. This key is pre-scoped with the necessary minimal permissions (usually "Agent Read" or similar).
Crucial Step: The generated API key will be displayed. Copy it immediately. For security reasons, the full API key is often only displayed once.
Store this key in a secure location (e.g., a password manager).
Continue with Onboarding:
Follow the remaining prompts in the Onboarding Guide, which will instruct you on how to use this newly generated token in your GitHub Actions or Kubernetes deployments.
If you need to create an API key with specific, granular permissions beyond the default agent scope, or if you are not using the Onboarding Guide, you can use the "API Tokens" page.
Navigate to the API Tokens Page:
Log in to the Garnet Platform dashboard.
(If you previously saw references to ./images/api-tokens-page.png, this is where it would conceptually fit, showing the page itself before clicking create).
Initiate Token Creation:
Configure and Generate Token:
A modal menu will appear prompting you to "Create New API Token."
Token Name: Provide a descriptive name for your token (e.g., "CI/CD Pipeline Token," "Prod Cluster Read-Only").
Click the "Create Token" button in the modal.
Copy and Secure Your API Key:
Crucial Step: The newly generated API key value will be displayed. Copy it immediately.
Store this key securely. As with other methods, it will likely not be displayed again.
This API key will be used in the next step when setting up your Jibril agents. Remember to use the key with the appropriate permissions for your intended agent deployment.
From any page in the dashboard, click on the "API Tokens" button in the navigation menu. This will take you to the API Tokens management page (typically https://dashboard.garnet.ai/tokens).
On the "API Tokens" page, click the "+ Create Token" button.
Permissions: Select the specific permissions this token should have (e.g., List, Read, Create, Update, Delete for various resources). Carefully choose only the necessary permissions for the intended use of the token.
