Skip to main content
PATCH
cURL

Path Parameters

ruleId
string<uuid>
required

The ID of the Static Secrets Validation Rule to update.

Body

application/json
name
string

The updated name of the Static Secrets Validation Rule.

Required string length: 1 - 64
description
string | null

The updated description of the Static Secrets Validation Rule.

Maximum string length: 500
environment
string | null

The slug of the environment to scope this rule to. Pass null to enforce the rule in every environment of the project.

Required string length: 1 - 64
secretPath
string

The secret path to scope this rule to. Supports glob patterns such as /apps/**.

Required string length: 1 - 1024
isActive
boolean

Whether the rule is enforced. An inactive rule is kept but ignored.

keyConstraints
object | null

Constraints enforced on the secret key when a secret is created or renamed. Omit to leave keys unconstrained.

valueConstraints
object | null

Constraints enforced on the secret value when a secret is created or updated. Omit to leave values unconstrained.

Response

Default Response

secretValidationRule
Static Secrets · object
required