Mint an API key for a client; the key is shown once
- In the sandbox
In plain words
Makes an API key for a client. The key is shown once.
POST
The operator mints for any client. A client's admin key mints only for its own client and only scopes it holds. Only the SHA-256 is kept.
apiKeyheader
AuthorizationBearer <token>Send your key as a bearer token: Authorization: Bearer <your-api-key>. Health is the only call that needs no key.
application/json- body
client?stringMatch
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$scopes*array<>Items
1 <= itemslabel?stringLength
length <= 100Minted. key appears in this answer only.
application/json- response
id*stringclient*stringenvironment*stringValue in
"sandbox""production"scopes*array<>label?stringcreated_at*stringFormat
date-timerevoked_at?stringFormat
date-timealso_revoked?array<string>Only in a revoke answer, the ids of the keys minted under this one that were revoked with it.
key*stringMatch
^eik_(test|live)_[0-9a-f]{48}$curl -X POST "https://example.com/keys" \ -H "Authorization: Bearer <your-api-key>" \ -H "Content-Type: application/json" \ -d '{ "scopes": [ "submit" ] }'{ "id": "string", "client": "string", "environment": "sandbox", "scopes": [ "submit" ], "label": "string", "created_at": "2019-08-24T14:15:22Z", "revoked_at": "2019-08-24T14:15:22Z", "also_revoked": [ "string" ], "key": "string"}