hs-sql-agent
2.0.6
Docs 2.0.6
Documentation version
2.0.6
2.0.2 Supported 2.0.3 Supported 2.0.4 Supported 2.0.5 Supported 2.0.6 Supported 3.0.0 Latest
Docs Reference

Upgrade Guide

Upgrade to 2.0.6 with Management API Keys and its Admin Store migration.

2.0.5 → 2.0.6

Version 2.0.6 adds API keys for programmatic administration through the existing /api endpoints.

Upgrade steps

  1. Deploy the new server version and apply the Admin Store migration that creates ManagementApiKeys.
  2. Create a Management API Key in the Admin Console and select only the permissions the integration needs.
  3. Store the one-time secret securely and use the X-API-Key header for authorized requests.
  4. Verify expiry, revocation, and rotation in the integration.

Compatibility and rollback

Existing administrator sign-in and MCP client connections do not need to change. Older server versions cannot validate Management API Keys; stop using these keys before rolling back.

Management API Keys guide