Skip to main content
API keys allow you to authenticate to the Miru Platform API as well as the Miru CLI in your CI pipeline. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

​
Create an API key

To create an API key, navigate to the API Keys page and click New API Key in the top right.
New API Key Button
The Create API Key page will open. Enter a name and an optional description, then select the key’s scopes: each row is a resource, and selecting manage covers the rest of its row. Click Create. For a full reference of available scopes, see the Platform API Authorization page.
Create API Key Page
A dialog will appear with the new key. Copy it before clicking Done. It can never be retrieved again; if you lose it, create a new one.

​
View API keys

To view your workspace’s API keys, navigate to the API Keys page. Each key is listed by name; click a key to expand it and see its details:
  • Last used: when the key was last used, or Never used.
  • Description: what the key is for, or None.
  • Created: when the key was created.
  • Created by: who created the key.
  • Scopes: what the key can access.
API Key Details

​
Edit an API key

To edit an API key, click the ellipses (…) on the key, or right-click it, and select Edit.
Edit API Key Menu
The Edit API Key page will open. Change the key’s name, description, or scopes, then click Save. The key itself doesn’t change, so anything using it keeps working with the new scopes.
Edit API Key Page

​
Delete an API key

Deleting an API key immediately revokes it. Attempting to authenticate with a deleted API key will fail. Furthermore, deleting an API key is irreversible. Once an API key is deleted, it cannot be recovered. To delete an API key, click the ellipses (…) on the key, or right-click it, and select Delete.
Delete API Key Menu
A confirmation dialog will appear. Hit Delete to confirm the deletion.
Last modified on September 29, 2026