Skip to main content
PATCH
Update rule

Path Parameters

ruleId
string
required

Body

application/json
title
string
Required string length: 1 - 200
content
string
Required string length: 1 - 10000
applicationShortId
string | null

Set to an application short id to scope the rule, or null to clear the filter

Pattern: ^app(-.+_.+|_.+)$
labelFilter
string | null

Set to a label to scope the rule, or null to clear the filter

scenarioShortIds
string[] | null

Set to scenario short ids to scope the rule, or null to clear the filter

Pattern: ^scenario(-.+_.+|_.+)$
urlPathFilter
string | null

Set to a URL path substring to scope the rule, or null to clear the filter

sortOrder
integer<int32>

Rules are applied in ascending sort order

projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

success
boolean
required
rule
object
required