REredis
v2
pipelines
secrets

Update Secret

Changed on

Updates a pipeline secret, or creates it if it does not exist.

put/api/v2/pipelines/{name}/secrets/{key}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/pipelines/{name}/secrets/{key}
  • Auth
    HTTP bearer

Path parameters

namestring required

Pipeline name

keystring required

Pipeline secret key

Query parameters

dbstring nullable

The database a secret belongs to: a source name, or 'target' for the target database. Omit for legacy SOURCE_DB_* and TARGET_DB_* keys.

Request body

valuestring required
type'simple' | 'file' | 'binary_file'

Response

Successful Response

keystring required
dbstring required
type'simple' | 'file' | 'binary_file' required

Changes

  • 38675c1371b2Revision changes
    • info

      added the new optional query request parameter db

    • info

      added the required property to the response with the status

  • e381b64b5ffcRevision changes
    • warning

      added the new binary_file enum value to the response property for the response status

    • info

      added the new binary_file enum value to the request property