Skip to main content

Secrets

Secrets store the keys and tokens used by workflow tasks to interact with external systems, such as a password to connect to an external database or an API token.

Path and query parameters

Name

Type

Location

Req/Opt

Description

workspaceId

integer

query

Optional

Workspace numeric identifier

name

string

query

Optional

Secret name to validate

secretId

integer

path

Required

Secret numeric identifier

Request body parameters

Name

Type

Req/Opt

Description

CreatePipelineSecret

Create pipeline secret

name

string

Optional

Secret name used by Nextflow when resolving this pipeline secret.

value

string

Optional

Secret value stored securely for use in pipeline launches.

UpdatePipelineSecret

Update secret

value

string

Optional

Updated secret value stored securely for future pipeline launches.