Skip to main content
POST
cURL

Body

application/json
name
string
required

The name of the Secret Rotations Validation Rule to create.

Required string length: 1 - 64
projectId
string
required

The ID of the project to create the Secret Rotations 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
providers
enum<string>[]
required

The secret rotation providers this rule applies to. A rotation is only constrained when its provider is listed here.

Minimum array length: 1
Available options:
postgres-credentials,
mysql-credentials,
mssql-credentials,
oracledb-credentials,
unix-linux-local-account,
ldap-password
passwordConstraints
object
required

Constraints the generated password must satisfy. These replace any password requirements configured on the resource itself.

description
string | null

An optional description of the Secret Rotations 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.

Response

Default Response

secretValidationRule
Secret Rotations · object
required