Create API Key

POST

/v1/subaccounts/:id/keys

Create an API key for a subaccount. Use this when a tenant, service, or environment needs its own credentials to call BCTRL.

AuthorizationBearer

Use Bearer <api-key>.

idstringRequired

This endpoint expects an object.

namestringRequired1-200 characters

expiresAtdatetime or nullOptional

Default Response

apiKeyobject

keystring>=1 character

prefixstring>=1 character

1	curl -X POST https://api.bctrl.ai/v1/subaccounts/id/keys \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Service Integration Key"
6	}'

1	{
2	"apiKey": {
3	"createdAt": "2024-06-01T12:00:00Z",
4	"id": "api_1234567890abcdef",
5	"keyPrefix": "SIK",
6	"updatedAt": "2024-06-01T12:00:00Z",
7	"expiresAt": "2025-06-01T12:00:00Z",
8	"lastUsedAt": "2024-06-10T08:30:00Z",
9	"name": "Service Integration Key",
10	"usageCount": 42
11	},
12	"key": "SIK-abcdef1234567890abcdef1234567890",
13	"prefix": "SIK"
14	}