create_api_key
Generate API keys for sending metrics and data to Coroot observability platform. The secret key is provided only once during creation.
Instructions
Create a new API key for data ingestion.
Creates an API key that can be used for sending metrics and data. The key secret is only returned once during creation.
Args: project_id: Project ID name: API key name description: Optional description
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | ||
| name | Yes | ||
| description | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/mcp_coroot/server.py:1549-1563 (handler)The main MCP tool handler function for 'create_api_key', decorated with @mcp.tool(). It delegates to the internal implementation helper.
@mcp.tool() async def create_api_key( project_id: str, name: str, description: str | None = None ) -> dict[str, Any]: """Create a new API key for data ingestion. Creates an API key that can be used for sending metrics and data. The key secret is only returned once during creation. Args: project_id: Project ID name: API key name description: Optional description """ return await create_api_key_impl(project_id, name, description) # type: ignore[no-any-return] - src/mcp_coroot/server.py:1537-1546 (helper)Internal helper function that handles errors and calls the CorootClient.create_api_key method.
async def create_api_key_impl( project_id: str, name: str, description: str | None = None ) -> dict[str, Any]: """Create an API key.""" result = await get_client().create_api_key(project_id, name, description) return { "success": True, "message": "API key created successfully", "api_key": result, } - src/mcp_coroot/client.py:1171-1195 (helper)CorootClient class method that performs the actual HTTP POST request to the Coroot API to generate a new API key.
async def create_api_key( self, project_id: str, name: str, description: str | None = None ) -> dict[str, Any]: """Create a new API key. Args: project_id: Project ID. name: API key name (used as description in Coroot). description: Optional description (not used by Coroot). Returns: Created API key with secret. """ # Coroot expects 'action' and 'description' fields data = { "action": "generate", "description": name, # Coroot uses 'description' not 'name' } response = await self._request( "POST", f"/api/project/{project_id}/api_keys", json=data, ) return self._parse_json_response(response)