Automation Rules

POST /v1/automation-rules/actions/bulk

POST /v1/automation-rules/actions/bulk

Required scopes: automation_rules:write

post/v1/automation-rules/actions/bulk

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/automation-rules/actions/bulk
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Request body

action'on' | 'off' | 'delete' required
mode'preview' | 'apply' required
rule_idsstring[]

Response

Affected rules and skipped rules. Show preview to the user and get confirmation before apply. Apply requires exact rule_ids returned by preview, never a filter. Pick a step rules cannot be switched on. Shared pipeline rules change for every job on that pipeline, including jobs outside the filter.

mode'preview' | 'apply' required
action'on' | 'off' | 'delete' required

Changes

No recorded changes to this operation across all 1 revision of this API.