Keypair
A key pair is a public key and private key associated with a principal. The public key identifies the pair for listing and deletion; the private key is a secret returned only at creation time. Registration issues your first pair on the Welcome page—see Account and credentials.
Use these endpoints to generate additional pairs, inventory public keys, or remove pairs you no longer need. Treat the private key with the same care as an API key: store it securely and never put it in source control, logs, or public clients.
Create, list, and delete#
Create → save publicKey + privateKey once → list shows publicKey only → delete by publicKey
- Create returns both
publicKeyandprivateKey—capture the private key immediately; it may not be shown again. - List returns public keys for a principal (optional glob
pattern), never private keys. - Delete removes the pair identified by
publicKeyin the request body (204, no body).
Confirm nothing still depends on a pair before deleting it. To rotate, create a new pair, update dependents, then delete the old public key.
When to use these endpoints#
- Generate a pair for a principal that needs cryptographic credentials beyond the Welcome pair
- List public keys when auditing or preparing deletion
- Delete after rotation, offboarding, or when a private key may have been exposed