Keys

Create an API key

Mint a key. The secret is returned once, in this response, and cannot be retrieved afterwards. Requires the keys:write scope. A key can only grant within its own reach: a key narrowed to one domain cannot create a team-wide key, or reach a domain it does not hold. keys:write cannot be combined with dns01:write on one key. A key carrying hostnames:write may grant dns01:write on a hostname it reaches without holding it, which is how a per-machine renewal credential is minted; that grant must name a hostname, so no domain-wide or team-wide DNS-01 key can be created through the API.

post/v1/keys

Request

  • Base URL: https://dnsmint.com/api
  • URL: https://dnsmint.com/api/v1/keys
  • Auth: HTTP bearer

Request body

namestring
expires_in_daysinteger nullable

Days until the key stops working. Null or omitted for a key that does not expire.

Response

Created. Contains the only copy of the secret.

key_idstring

The id half of dnsm_<key_id>_<secret>.

namestring
created_atstring date-time
last_used_atstring date-time nullable
expires_atstring date-time nullable

Null for a key that does not expire.

created_by_key_idstring nullable

The key that minted this one, or null when a person created it in the dashboard.

expiredboolean
keystring required

The full secret, dnsm_<key_id>_<secret>. Returned only here and never retrievable again.

Changes

No recorded changes to this operation across all 1 revision of this API.