Secret¶

Credentials such as usernames, passwords, API keys and private keys can be added to the system and then be used by referencing them by alias. The secret values are write-only. See Storage Credentials for more information.

New in version 23.1.

Managing secrets
Managing secret values

Managing secrets ¶

Retrieve all secrets¶

GET /secret¶

Returns all secrets and the value keys that each secret has set. Note that secret values are not returned.

Produces:	application/xml, application/json – SecretListDocument
Role:	_administrator

Retrieve a specific secret¶

GET /secret/(alias)¶

Returns the secret with the given alias and the value keys that the secret has set. Note that secret values are not returned.

Produces:	application/xml, application/json – SecretDocument
Role:	_administrator

Create a new secret¶

PUT /secret/(alias)¶

Creates a new secret with the given alias.

Produces:	application/xml, application/json – SecretDocument
Role:	_administrator

Delete a secret¶

DELETE /secret/(alias)¶

Deletes the secret with the given alias.

Role:	_administrator

Managing secret values ¶

Add or update a secret value¶

PUT /secret/(alias)/(key)¶

Adds or updates a secret value with the given alias and key.

Valid keys are:

username

password

private_key

private_key_password

See Storage Credentials for more information about these keys.

Accepts:	text/plain – The secret value.
Role:	_administrator

Remove a secret value¶

DELETE /secret/(alias)/(key)¶

Removes the secret value with the given alias and key.