Create a connector and its single-use enrollment token (dashboard session only)

POST

/connectors

curl --request POST \
  --url https://api.krakenkey.io/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "web-01", "clientLabel": "Acme Corp", "scopes": [ "certs:read" ], "allowedCertIds": [ 1 ], "allowedDomainIds": [ "example" ] }'

Authorizations

• bearer

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 64 characters

Example

web-01

clientLabel

Customer or site the connector runs for

string

>= 1 characters <= 64 characters

Example

Acme Corp

scopes

required

Scopes of the keys the connector gets. Must include certs:read.

Array<string>

Allowed values: certs:read certs:renew

allowedCertIds

Certificates the connector may use. At least one of allowedCertIds and allowedDomainIds is required.

Array<number>

allowedDomainIds

Domains the connector may use certificates for. At least one of allowedCertIds and allowedDomainIds is required.

Array<string>

Responses

201

Connector created; the enrollment token is shown once

402

Connector limit reached