v4

latestOpenAPI 3.0.32026-07-312,317012.2 MB
Secrets

Update secret

patch/api/v3/secrets/raw/{secretName}

Path parameters

secretNamestring required

The name of the secret to update.

Request body

workspaceIdstring

The ID of the project to update the secret in.

projectSlugstring

The slug of the project to update the secret in.

environmentstring required

The slug of the environment where the secret is located.

secretValuestring

The new value of the secret.

secretPathstring

The default path for secrets to update or upsert, if not provided in the secret details.

skipMultilineEncodingboolean

Skip multiline encoding for the secret value.

type'shared' | 'personal'

The type of the secret to update.

tagIdsstring[]

The ID of the tags to be attached to the updated secret.

metadataobject
secretReminderNotestring nullable

Note to be attached in notification email.

secretReminderRepeatDaysnumber nullable

Interval for secret rotation notifications, measured in days.

secretReminderRecipientsstring[]

An array of user IDs that will receive the reminder email. If not specified, all project members will receive the reminder email.

newSecretNamestring

The new name for the secret.

secretCommentstring

Update comment to the secret.

Response

Default Response

OR