Skip to content

docs: update agent templating functions #5727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
varonix0 merged 4 commits into from
Mar 17, 2026
Merged

docs: update agent templating functions #5727

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bb21027
docs: agent updated templating functions
varonix0 Mar 16, 2026
c779389
Update docs/integrations/platforms/infisical-agent.mdx
varonix0 Mar 16, 2026
f6454c1
Update infisical-agent.mdx
varonix0 Mar 16, 2026
2161498
Merge branch 'daniel/agent-templating-funcs-docs' of https://github.c…
varonix0 Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 49 additions & 12 deletions docs/integrations/platforms/infisical-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,19 @@ The secret template functions is what you will use to fetch resources such as st


<AccordionGroup>
<Accordion title="secret">
<Accordion title="listSecrets">
```bash
secret "<project-id>" "environment-slug" "<secret-path>" "<optional-modifier>"
listSecrets "<project-id>" "environment-slug" "<secret-path>" "<optional-modifier>"
```
```bash example-template-usage-1
{{- with secret "6553ccb2b7da580d7f6e7260" "dev" "/" `{"recursive": false, "expandSecretReferences": true}` }}
{{- with listSecrets "6553ccb2b7da580d7f6e7260" "dev" "/" `{"recursive": false, "expandSecretReferences": true}` }}
{{- range . }}
{{ .Key }}={{ .Value }}
{{- end }}
{{- end }}
```
```bash example-template-usage-2
{{- with secret "da8056c8-01e2-4d24-b39f-cb4e004b8d44" "staging" "/" `{"recursive": true, "expandSecretReferences": true}` }}
{{- with listSecrets "da8056c8-01e2-4d24-b39f-cb4e004b8d44" "staging" "/" `{"recursive": true, "expandSecretReferences": true}` }}
{{- range . }}
{{- if eq .SecretPath "/"}}
{{ .Key }}={{ .Value }}
Expand All @@ -72,7 +72,7 @@ The secret template functions is what you will use to fetch resources such as st



**Function name**: `secret`
**Function name**: `listSecrets`

**Description**: This function can be used to render the full list of secrets within a given project, environment and secret path.

Expand All @@ -83,6 +83,43 @@ The secret template functions is what you will use to fetch resources such as st

</Accordion>

<Accordion title="listSecretsByProjectSlug">
```bash
listSecretsByProjectSlug "<project-slug>" "environment-slug" "<secret-path>" "<optional-modifier>"
```
```bash example-template-usage-1
{{- with listSecretsByProjectSlug "my-project" "dev" "/" `{"recursive": false, "expandSecretReferences": true}` }}
{{- range . }}
{{ .Key }}={{ .Value }}
{{- end }}
{{- end }}
```
```bash example-template-usage-2
{{- with listSecretsByProjectSlug "my-project" "staging" "/" `{"recursive": true, "expandSecretReferences": true}` }}
{{- range . }}
{{- if eq .SecretPath "/"}}
{{ .Key }}={{ .Value }}
{{- else}}
{{ .SecretPath }}/{{ .Key }}={{ .Value }}
{{- end}}
{{- end }}
{{- end }}
```



**Function name**: `listSecretsByProjectSlug`

**Description**: This function can be used to render the full list of secrets within a given project slug, environment and secret path.

An optional JSON argument is also available. It includes the properties `recursive`, which defaults to false, and `expandSecretReferences`, which defaults to true and expands the returned secrets.


**Returns**: A list of secret objects, each with the following keys `Key, WorkspaceId, Value, SecretPath, Type, ID, and Comment`

</Accordion>


<Accordion title="getSecretByName">
```bash
getSecretByName "<project-id>" "<environment-slug>" "<secret-path>" "<secret-name>"
Expand All @@ -104,19 +141,19 @@ The secret template functions is what you will use to fetch resources such as st

</Accordion>

<Accordion title="dynamic_secret">
<Accordion title="dynamicSecret">
```bash
dynamic_secret "<project-slug>" "<environment-slug>" "<secret-path>" "<dynamic-secret-name>" "<lease-ttl>"
dynamicSecret "<project-slug>" "<environment-slug>" "<secret-path>" "<dynamic-secret-name>" "<lease-ttl>"
```

```bash example-redis-dynamic-secret
{{ with dynamic_secret "aaa-o7en-s5qm" "dev" "/" "redis" "1m" }}
{{ with dynamicSecret "aaa-o7en-s5qm" "dev" "/" "redis" "1m" }}
{{ .DB_USERNAME }}={{ .DB_PASSWORD }}
{{- end }}

```

**Function Name**: `dynamic_secret`
**Function Name**: `dynamicSecret`

**Description**: This function can be used to render a dynamic secret lease credentials. The credentials are automatically renewed before they expire, ensuring that the rendered credentials are always up-to-date.

Expand Down Expand Up @@ -465,11 +502,11 @@ templates:
command: ./reload-app.sh
```

The secret template below will be used to render the secrets with the key and the value separated by `=` sign. You'll notice that a custom function named `secret` is used to fetch the secrets.
This function takes the following arguments: `secret "<project-id>" "<environment-slug>" "<secret-path>"`.
The secret template below will be used to render the secrets with the key and the value separated by `=` sign. You'll notice that a custom function named `listSecrets` is used to fetch the secrets.
This function takes the following arguments: `listSecrets "<project-id>" "<environment-slug>" "<secret-path>"`.

```text my-dot-ev-secret-template
{{- with secret "6553ccb2b7da580d7f6e7260" "dev" "/" }}
{{- with listSecrets "6553ccb2b7da580d7f6e7260" "dev" "/" }}
{{- range . }}
{{ .Key }}={{ .Value }}
{{- end }}
Expand Down
Loading