API Keys

API keys provide secure programmatic access to Bot Management Console resources, such as queues and task execution.

API Key Overview

API keys are displayed in a table showing:

• API Key: Masked key value (partially hidden for security)
• Description: Purpose or description of the key

Creating an API Key

To create a new API key:

1. Navigate to the API Keys section
2. Click the Add API Key button
3. Provide:
   • Description: Purpose of the API key
   • Expiry Date: Optional expiration date (if needed)
4. Click Create API Key

The system generates a new API key. Copy and store it securely, as it won't be shown again in full.

Using API Keys

Include your API key in request headers when making API calls:

x-api-key: your-api-key-here

API keys are required for:

• Submitting data to queues
• Triggering task execution
• Accessing other programmatic endpoints