Skip to main content
PATCH
Set or clear paths filters on jobs

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer <key>. An organization admin creates one in the Trunk app under Settings → Developer → API Keys and chooses the permissions it holds. A new key starts with no permissions: it can read merge queues but change nothing in them, and it cannot get a Dynamic CI plan. Each endpoint that needs a permission names it in its description; the Dynamic CI plan endpoints need Generate Dynamic CI plans.

Body

application/json
repo
object
required
overwrite
boolean
default:false

Replace a different filter already on a job. Without it, such a job fails the request with PATHS_FILTER_CONFLICT.

Example:

false

filters
object[]
Maximum array length: 100
clear
object[]

Jobs to remove the paths filter from.

Maximum array length: 500

A job, as { workflowPath, jobKey } or as { jobId }.

Response

What the request did to each job

filters
object[]
required

One per filters entry, leaving out an entry none of whose jobs resolved.

Maximum array length: 100
jobs
object[]
required

One per job named, in request order. A job named by jobId is reported by its path and key.

Maximum array length: 500