Skip to content

Commit cb35c03

Browse files
committed
Update README.md
1 parent 0f8a14f commit cb35c03

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,11 @@ secrets = client.secrets.list_secrets(
8282
project_id="<project-id>",
8383
environment_slug="dev",
8484
secret_path="/",
85-
expand_secret_references=True,
86-
recursive=False,
87-
include_imports=True,
88-
tag_filters=[]
85+
expand_secret_references=True, # Optional
86+
view_secret_value=True, # Optional
87+
recursive=False, # Optional
88+
include_imports=True, # Optional
89+
tag_filters=[] # Optional
8990
)
9091
```
9192

@@ -94,6 +95,7 @@ secrets = client.secrets.list_secrets(
9495
- `environment_slug` (str): The environment in which to list secrets (e.g., "dev").
9596
- `secret_path` (str): The path to the secrets.
9697
- `expand_secret_references` (bool): Whether to expand secret references.
98+
- `view_secret_value` (bool): Whether or not to include the secret value in the response. If set to false, the `secretValue` will be masked with `<hidden-by-infisical>`. Defaults to true.
9799
- `recursive` (bool): Whether to list secrets recursively.
98100
- `include_imports` (bool): Whether to include imported secrets.
99101
- `tag_filters` (List[str]): Tags to filter secrets.
@@ -171,9 +173,10 @@ secret = client.secrets.get_secret_by_name(
171173
project_id="<project-id>",
172174
environment_slug="dev",
173175
secret_path="/",
174-
expand_secret_references=True,
175-
include_imports=True,
176-
version=None # Optional
176+
expand_secret_references=True, # Optional
177+
view_secret_value=True, # Optional
178+
include_imports=True, # Optional
179+
version=None # Optional
177180
)
178181
```
179182

@@ -183,6 +186,7 @@ secret = client.secrets.get_secret_by_name(
183186
- `environment_slug` (str): The environment in which to retrieve the secret.
184187
- `secret_path` (str): The path to the secret.
185188
- `expand_secret_references` (bool): Whether to expand secret references.
189+
- `view_secret_value` (bool): Whether or not to include the secret value in the response. If set to false, the `secretValue` will be masked with `<hidden-by-infisical>`. Defaults to true.
186190
- `include_imports` (bool): Whether to include imported secrets.
187191
- `version` (str, optional): The version of the secret to retrieve. Fetches the latest by default.
188192

0 commit comments

Comments
 (0)