Infisical

使用说明

Integrate Infisical into your workflow. List, get, create, update, and delete secrets across project environments.

List all secrets in a project environment. Returns secret keys, values, comments, tags, and metadata.

参数	类型	必填	描述
`apiKey`	string	是	Infisical API token
`baseUrl`	string	否	Infisical instance URL (default: "https://us.infisical.com"\). Use "https://eu.infisical.com" for EU Cloud or your dedicated Infisical base URL.
`projectId`	string	是	The ID of the project to list secrets from
`environment`	string	是	The environment slug (e.g., "dev", "staging", "prod")
`secretPath`	string	否	The path of the secrets (default: "/")
`recursive`	boolean	否	Whether to fetch secrets recursively from subdirectories
`expandSecretReferences`	boolean	否	Whether to expand secret references (default: true)
`viewSecretValue`	boolean	否	Whether to include secret values in the response (default: true)
`includeImports`	boolean	否	Whether to include imported secrets (default: true)
`tagSlugs`	string	否	Comma-separated tag slugs to filter secrets by

参数	类型	描述
`secrets`	array	Array of secrets
↳ `id`	string	Secret ID
↳ `workspace`	string	Workspace/project ID
↳ `secretKey`	string	Secret name/key
↳ `secretValue`	string	Secret value
↳ `secretComment`	string	Secret comment
↳ `secretPath`	string	Secret path
↳ `version`	number	Secret version
↳ `type`	string	Secret type (shared or personal)
↳ `environment`	string	Environment slug
↳ `tags`	array	Tags attached to the secret
↳ `id`	string	Tag ID
↳ `slug`	string	Tag slug
↳ `color`	string	Tag color
↳ `name`	string	Tag name
↳ `secretMetadata`	array	Custom metadata key-value pairs
↳ `key`	string	Metadata key
↳ `value`	string	Metadata value
↳ `createdAt`	string	Creation timestamp
↳ `updatedAt`	string	Last update timestamp
`count`	number	Total number of secrets returned

Retrieve a single secret by name from a project environment.

参数	类型	必填	描述
`apiKey`	string	是	Infisical API token
`baseUrl`	string	否	Infisical instance URL (default: "https://us.infisical.com"\). Use "https://eu.infisical.com" for EU Cloud or your dedicated Infisical base URL.
`projectId`	string	是	The ID of the project
`environment`	string	是	The environment slug (e.g., "dev", "staging", "prod")
`secretName`	string	是	The name of the secret to retrieve
`secretPath`	string	否	The path of the secret (default: "/")
`version`	number	否	Specific version of the secret to retrieve
`type`	string	否	Secret type: "shared" or "personal" (default: "shared")
`viewSecretValue`	boolean	否	Whether to include the secret value in the response (default: true)
`expandSecretReferences`	boolean	否	Whether to expand secret references (default: true)

参数	类型	描述
`secret`	object	The retrieved secret
↳ `id`	string	Secret ID
↳ `workspace`	string	Workspace/project ID
↳ `secretKey`	string	Secret name/key
↳ `secretValue`	string	Secret value
↳ `secretComment`	string	Secret comment
↳ `secretPath`	string	Secret path
↳ `version`	number	Secret version
↳ `type`	string	Secret type (shared or personal)
↳ `environment`	string	Environment slug
↳ `tags`	array	Tags attached to the secret
↳ `id`	string	Tag ID
↳ `slug`	string	Tag slug
↳ `color`	string	Tag color
↳ `name`	string	Tag name
↳ `secretMetadata`	array	Custom metadata key-value pairs
↳ `key`	string	Metadata key
↳ `value`	string	Metadata value
↳ `createdAt`	string	Creation timestamp
↳ `updatedAt`	string	Last update timestamp

Create a new secret in a project environment.

参数	类型	必填	描述
`apiKey`	string	是	Infisical API token
`baseUrl`	string	否	Infisical instance URL (default: "https://us.infisical.com"\). Use "https://eu.infisical.com" for EU Cloud or your dedicated Infisical base URL.
`projectId`	string	是	The ID of the project
`environment`	string	是	The environment slug (e.g., "dev", "staging", "prod")
`secretName`	string	是	The name of the secret to create
`secretValue`	string	是	The value of the secret
`secretPath`	string	否	The path for the secret (default: "/")
`secretComment`	string	否	A comment for the secret
`type`	string	否	Secret type: "shared" or "personal" (default: "shared")
`tagIds`	string	否	Comma-separated tag IDs to attach to the secret

参数	类型	描述
`secret`	object	The created secret
↳ `id`	string	Secret ID
↳ `workspace`	string	Workspace/project ID
↳ `secretKey`	string	Secret name/key
↳ `secretValue`	string	Secret value
↳ `secretComment`	string	Secret comment
↳ `secretPath`	string	Secret path
↳ `version`	number	Secret version
↳ `type`	string	Secret type (shared or personal)
↳ `environment`	string	Environment slug
↳ `tags`	array	Tags attached to the secret
↳ `id`	string	Tag ID
↳ `slug`	string	Tag slug
↳ `color`	string	Tag color
↳ `name`	string	Tag name
↳ `secretMetadata`	array	Custom metadata key-value pairs
↳ `key`	string	Metadata key
↳ `value`	string	Metadata value
↳ `createdAt`	string	Creation timestamp
↳ `updatedAt`	string	Last update timestamp

Update an existing secret in a project environment.

参数	类型	必填	描述
`apiKey`	string	是	Infisical API token
`baseUrl`	string	否	Infisical instance URL (default: "https://us.infisical.com"\). Use "https://eu.infisical.com" for EU Cloud or your dedicated Infisical base URL.
`projectId`	string	是	The ID of the project
`environment`	string	是	The environment slug (e.g., "dev", "staging", "prod")
`secretName`	string	是	The name of the secret to update
`secretValue`	string	否	The new value for the secret
`secretPath`	string	否	The path of the secret (default: "/")
`secretComment`	string	否	A comment for the secret
`newSecretName`	string	否	New name for the secret (to rename it)
`type`	string	否	Secret type: "shared" or "personal" (default: "shared")
`tagIds`	string	否	Comma-separated tag IDs to set on the secret

参数	类型	描述
`secret`	object	The updated secret
↳ `id`	string	Secret ID
↳ `workspace`	string	Workspace/project ID
↳ `secretKey`	string	Secret name/key
↳ `secretValue`	string	Secret value
↳ `secretComment`	string	Secret comment
↳ `secretPath`	string	Secret path
↳ `version`	number	Secret version
↳ `type`	string	Secret type (shared or personal)
↳ `environment`	string	Environment slug
↳ `tags`	array	Tags attached to the secret
↳ `id`	string	Tag ID
↳ `slug`	string	Tag slug
↳ `color`	string	Tag color
↳ `name`	string	Tag name
↳ `secretMetadata`	array	Custom metadata key-value pairs
↳ `key`	string	Metadata key
↳ `value`	string	Metadata value
↳ `createdAt`	string	Creation timestamp
↳ `updatedAt`	string	Last update timestamp

Delete a secret from a project environment.

参数	类型	必填	描述
`apiKey`	string	是	Infisical API token
`baseUrl`	string	否	Infisical instance URL (default: "https://us.infisical.com"\). Use "https://eu.infisical.com" for EU Cloud or your dedicated Infisical base URL.
`projectId`	string	是	The ID of the project
`environment`	string	是	The environment slug (e.g., "dev", "staging", "prod")
`secretName`	string	是	The name of the secret to delete
`secretPath`	string	否	The path of the secret (default: "/")
`type`	string	否	Secret type: "shared" or "personal" (default: "shared")

参数	类型	描述
`secret`	object	The deleted secret
↳ `id`	string	Secret ID
↳ `workspace`	string	Workspace/project ID
↳ `secretKey`	string	Secret name/key
↳ `secretValue`	string	Secret value
↳ `secretComment`	string	Secret comment
↳ `secretPath`	string	Secret path
↳ `version`	number	Secret version
↳ `type`	string	Secret type (shared or personal)
↳ `environment`	string	Environment slug
↳ `tags`	array	Tags attached to the secret
↳ `id`	string	Tag ID
↳ `slug`	string	Tag slug
↳ `color`	string	Tag color
↳ `name`	string	Tag name
↳ `secretMetadata`	array	Custom metadata key-value pairs
↳ `key`	string	Metadata key
↳ `value`	string	Metadata value
↳ `createdAt`	string	Creation timestamp
↳ `updatedAt`	string	Last update timestamp