Skip to content

SecretCLI

create

create(name, file, driver=None, labels={}, template_driver=None)

Creates a python_on_whales.Secret.

Returns

A `python_on_whales.Secret` object.

inspect

inspect(x)

Returns one or more python_on_whales.Secret based on an ID or name.

Parameters:

Name Type Description Default
x Union[str, List[str]]

One or more IDs/names.

required

list

list(filters={})

Returns all secrets as a List[python_on_whales.Secret].

remove

remove(x)

Removes one or more secrets

Parameters:

Name Type Description Default
x Union[ValidSecret, List[ValidSecret]]

One or more secrets. Name, ids or python_on_whales.Secret objects are valid inputs.

required