CircleCI Connection
Learn how to configure a CircleCI Connection for Hanzo KMS.
Hanzo KMS supports the use of API Tokens to connect with CircleCI.
CircleCI requires the account user to have Read/Write or Admin permissions
Create a CircleCI API Token
Click the "Create new token" button to create a new personal API token.
After creating the token, save the shown token value as it will not be shown again. You will need this token to configure your Hanzo KMS connection
Create a CircleCI Connection in Hanzo KMS
In your Hanzo KMS dashboard, navigate to the Integrations tab in the desired project, then select App Connections.
Click + Add Connection and choose CircleCI Connection from the list of integrations.
Complete the form by providing:
- A descriptive name for the connection
- An optional description
- The API Token value from the previous step
After submitting the form, your CircleCI Connection will be successfully created and ready to use with your Hanzo KMS project.
To create a CircleCI Connection via API, send a request to the Create CircleCI Connection endpoint.
Sample request
curl --request POST \
--url https://app.kms.hanzo.ai/api/v1/app-connections/circleci \
--header 'Content-Type: application/json' \
--data '{
"name": "my-circleci-connection",
"method": "api-token",
"projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
"credentials": {
"apiToken": "[API TOKEN]"
}
}'Sample response
{
"appConnection": {
"id": "e5d18aca-86f7-4026-a95e-efb8aeb0d8e6",
"name": "my-circleci-connection",
"projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
"description": null,
"version": 1,
"orgId": "6f03caa1-a5de-43ce-b127-95a145d3464c",
"createdAt": "2025-04-23T19:46:34.831Z",
"updatedAt": "2025-04-23T19:46:34.831Z",
"isPlatformManagedCredentials": false,
"credentialsHash": "7c2d371dec195f82a6a0d5b41c970a229cfcaf88e894a5b6395e2dbd0280661f",
"app": "circleci",
"method": "api-token",
"credentials": {}
}
}How is this guide?
Last updated on