Vaults#

Do not construct this object directly, instead access the vaults property of an ngrok.Client object.

class ngrok.services.VaultsClient(client)[source]#

Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

create(name='', metadata='', description='')[source]#

Create a new Vault

Parameters:

name (str) – Name of vault
metadata (str) – Arbitrary user-defined metadata for this Vault
description (str) – description of Vault

https://ngrok.com/docs/api#api-vaults-create

Return type:: Vault

delete(id)[source]#

Delete a Vault

Parameters:: id (str) – a resource identifier

https://ngrok.com/docs/api#api-vaults-delete

get(id)[source]#

Get a Vault by ID

Parameters:: id (str) – a resource identifier

https://ngrok.com/docs/api#api-vaults-get

Return type:: Vault

get_secrets_by_vault(id, before_id=None, limit=None)[source]#

Get Secrets by Vault ID

Parameters:

id (str) – a resource identifier
before_id (str) –
limit (str) –

https://ngrok.com/docs/api#api-vaults-get-secrets-by-vault

Return type:: SecretList

list(before_id=None, limit=None, filter=None)[source]#

List all Vaults owned by account

Parameters:

before_id (str) – Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.
limit (str) – Constrains the number of results in the dataset. See the API Overview for details.
filter (str) – A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering.

https://ngrok.com/docs/api#api-vaults-list

Return type:: VaultList

update(id, name=None, metadata=None, description=None)[source]#

Update an existing Vault by ID

Parameters:

id (str) – identifier for Vault
name (str) – Name of vault
metadata (str) – Arbitrary user-defined metadata for this Vault
description (str) – description of Vault

https://ngrok.com/docs/api#api-vaults-update

Return type:: Vault