Secret

List secrets¶

GET/api/v2/databases/{database}/schemas/{schema}/secrets

List secrets

Parameter	Description
database string	Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases.
schema	Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database.

Parameter	Description
like string	Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWith string	Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimit integer	Parameter to limit the maximum number of rows returned by a command.
fromName string	Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.

Code	Description
200	successful
202	Successfully accepted the request, but it is not completed yet.

POST/api/v2/databases/{database}/schemas/{schema}/secrets

Create a secret

Parameter	Description
createMode string	Parameter allowing support for different modes of resource creation. Possible values include: errorIfExists: Throws an error if you try to create a resource that already exists. orReplace: Automatically replaces the existing resource with the current one. ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Code	Description
200	Successful request.
202

GET/api/v2/databases/{database}/schemas/{schema}/secrets/{name}

Fetch a secret

Parameter	Description
name	Identifier (i.e. name) for the resource.

Code	Description
200	successful
202

DELETE/api/v2/databases/{database}/schemas/{schema}/secrets/{name}

Delete a secret

Parameter	Description
ifExists boolean	Parameter that specifies how to handle the request for a resource that does not exist: true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. false: The endpoint throws an error if the resource doesn't exist.

Code	Description
200
202