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

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

List all Vaults owned by account

Parameters:

before_id (str) –
limit (str) –

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