Skip to content

Authentication

Access to the agent server is regulated using API keys. New keys are created from the command line using the create-auth command demonstrated below. Expiration times and descriptions are both optional but strongly encouraged.

kca create-auth --expires "2025-11-20-00:15:08" --description "My API key"

# ID: 1
# Key: 895c0bc6daf69fc8204a12101a6e18852908ef17b2f23e4c927df5bfab24d35b
# Description: My API key

The generated API key is only displayed once at creation and cannot be retrieved afterward. Existing keys, along with their associated metadata, can be listed using the list-auth command.

kca list-auth

# +----+---------------------+-------------+
# | id |       expires       | description |
# +----+---------------------+-------------+
# | 1  | 2025-11-20 00:15:08 |  My API key |
# +----+---------------------+-------------+

API keys can be removed using the delete-auth command with the ID value shown in the list output.

kca delete-auth 1

# Deleted API key 1