Skip to main content
API keys are project-scoped credentials used by services, CI pipelines, and backend systems to call MeshAgent APIs. If you plan to automate provisioning with the REST API, start by creating a key in MeshAgent Studio or the MeshAgent CLI.

​
Create a key in MeshAgent Studio

  1. Open your project in MeshAgent Studio.
  2. Go to API Keys.
  3. Create a new key and record the secret value. The secret is shown once.

​
Create a key with the CLI

You can also generate a key with the MeshAgent CLI. The value is only shown once. 
meshagent api-key create --activate my-service-key

​
Best practices

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