Skip to main content
API keys are project-scoped credentials for backend services, CI, and automation that call MeshAgent APIs. Use them when a service or script needs to act on behalf of the project. Do not put them in end-user clients or use them as the user’s sign-in credential. People using MeshAgent Studio or Powerboards sign in with MeshAgent directly. If you are building your own app on top of MeshAgent, use the API key on your backend, create an OAuth client for user sign-in when needed, and issue participant tokens to the client.

​
Create a key

You can create API keys in MeshAgent Studio or with the CLI. The secret value is only shown once.

​
MeshAgent Studio

  1. Open your project in MeshAgent Studio.
  2. Go to API Keys.
  3. Create a new key and save the secret value.

​
MeshAgent CLI

If you want to create a key from the terminal and activate it for local CLI use at the same time: 
meshagent api-key create my-service-key \
  --description "Used by the deploy pipeline" \
  --activate
--activate saves the new key in your local CLI project settings so commands that use an API key can pick it up automatically. To activate an existing key later, use: 
meshagent api-key activate <key-id>

​
Rotate or remove keys

List the keys in the active project: 
meshagent api-key list
Print the locally activated key id, or emit it as a shell export snippet: 
meshagent api-key get
meshagent api-key env
Delete a key you no longer need: 
meshagent api-key delete <key-id>

​
Best practices

  • Rotate regularly and delete unused keys.
  • Store keys securely in a secret manager or CI vault.
  • Avoid sharing keys across multiple services.