v22

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-07253798.6 KB
agents
agents
agents

Ban All Checks For Agent Run

Ban all checks for a PR and stop all related agents.

This endpoint:

  1. Flags the PR to prevent future CI/CD check suite events from being processed
  2. Stops all current agents for that PR
post/v1/organizations/{org_id}/agent/run/ban

Path parameters

org_idinteger required

Headers

{"stackTrail":"paths:/v1/organizations/{org_id}/agent/run/ban:post:parameters:1:schema","oasType":"schema","type":"unknown","title":"Authorization"}

Request body

agent_run_idinteger required
before_card_order_idstring nullable

Kanban order key of the card that should come before this agent run in the CANCELLED column

after_card_order_idstring nullable

Kanban order key of the card that should come after this agent run in the CANCELLED column

Response

Successful Response

{"stackTrail":"paths:/v1/organizations/{org_id}/agent/run/ban:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}