Skip to main content

Overview

API keys let you securely authenticate with Blnk Cloud APIs. They allow your applications, scripts, and automated workflows to interact with Blnk Cloud programmatically. You can manage your API keys in Settings > API Keys.
Keep your API keys secure and rotate them regularly. API keys provide full access to your account based on their assigned scopes. Never share API keys publicly or commit them to version control.

How API keys work

When you make an API call, include your API key in the request headers to verify your identity and authorize the operation on your Cloud workspace. Each API key has:
  • Name: A user-friendly identifier to help you organize and identify keys
  • Key prefix: A partial identifier visible in the API keys list (e.g., blnk_fdb796a5...)
  • Scopes: Permissions that define what the key can access (e.g., * for all permissions, or specific scopes like mcp:read, mcp:write)
  • Role: Always set to Member (cannot be changed)
  • Expiration: Optional expiration date, or “Never” for keys that don’t expire

Create an API key

1

Navigate to API Keys

  1. Go to Settings > API Keys in your Blnk Cloud dashboard.
  2. Click Create API Key button in the top-right corner of the API Keys page.
2

Configure your API key

Fill in the required information:
  1. Name: Enter a descriptive name for your API key (e.g., “Production API Key”, “Testing”, “Alerts Integration”)
  2. Scopes: Select the permissions for this key:
  • * for all permissions
  • Specific scopes like mcp:read, mcp:write for limited access
  1. Expires: Choose when the key should expire:
  • Select a specific date
  • Choose “Never” for keys that don’t expire
3

Save and copy your API key

After creating the key, the full API key will be displayed only once. Copy it immediately and store it securely.
You cannot retrieve the full API key after creation. If you lose the key, you must create a new one.

Revoke an API key

If you need to disable an API key without deleting it permanently, you can revoke it. Revoked keys cannot be used for authentication but remain visible in your API keys list for reference.
1

Open API key details

Click on the API key name in the API Keys table to view its details.
2

Revoke the key

In the API key details panel, click the Revoke Key button.
Revoking a key will immediately disable it. Any applications or scripts using this key will stop working until you create and configure a new key.
3

Confirm revocation

Confirm that you want to revoke the key. The key’s status will change to “Revoked” in the API Keys table.

Need help?

If you’re having trouble with Blnk Cloud, don’t hesitate to send us a message via email at [email protected] or send us a message here.