Skip to main content
POST
cURL

Body

application/json
name
string
required

The name of the Static Secrets Validation Rule to create.

Required string length: 1 - 64
projectId
string
required

The ID of the project to create the Static Secrets Validation Rule in.

Required string length: 1 - 36
secretPath
string
required

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

Required string length: 1 - 1024
description
string | null

An optional description of the Static Secrets Validation Rule.

Maximum string length: 500
environment
string

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

Required string length: 1 - 64
isActive
boolean
default:true

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

keyConstraints
object

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

valueConstraints
object

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