> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firedrill.run/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel a browser CI run

> Requires run.cancel and exact browserCiRunId confirmation. Repeated cancellation is safe; cancellation is recorded durably before child cleanup and survives coordinator restart. Poll until cancelled or superseded.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/projects/{projectId}/repositories/{repositoryBindingId}/browser-ci/runs/{browserCiRunId}/cancel
openapi: 3.1.0
info:
  title: Firedrill Control API
  version: 1.0.0
  description: >-
    The control plane for drills, drill runs, and the worlds they run in. Errors
    always carry the canonical envelope; unsafe operations require an
    Idempotency-Key; long work returns an operation resource.
servers:
  - url: https://api.firedrill.run
security:
  - controlCredential: []
tags:
  - name: authentication
    description: Sessions, CLI exchange, credentials, and verification keys.
    x-group: Authentication
  - name: organizations
    description: Organization members, billing, usage, retention, audit, and exports.
    x-group: Organizations
  - name: projects
    description: Project lifecycle, access, grants, and repository bindings.
    x-group: Projects
  - name: builds
    description: Immutable builds, uploads, source drafts, and world definitions.
    x-group: Builds and source
  - name: tools
    description: Project Tool discovery, approval, source, and revocation.
    x-group: Tool library
  - name: worlds
    description: >-
      Managed environments, world sessions, state, time, reset, faults, forks,
      and snapshots.
    x-group: Environments and sessions
  - name: runs
    description: >-
      Hosted runs, comparisons, attachments, reports, evidence bundles, sharing,
      and exports.
    x-group: Runs and evidence
  - name: browser
    description: Managed browser tests, runs, messages, streams, frames, and artifacts.
    x-group: Browser testing
  - name: callbacks
    description: Callback receiver approval, revocation, and signing material.
    x-group: Callbacks
  - name: github-ci
    description: >-
      GitHub installations, repository automation, CI suites, cases, evidence,
      and checks.
    x-group: GitHub and CI
  - name: authoring
    description: Authoring sessions, proposals, turns, and scenario proposals.
    x-group: Cloud authoring
paths:
  /v1/projects/{projectId}/repositories/{repositoryBindingId}/browser-ci/runs/{browserCiRunId}/cancel:
    post:
      tags:
        - github-ci
      summary: Cancel a browser CI run
      description: >-
        Requires run.cancel and exact browserCiRunId confirmation. Repeated
        cancellation is safe; cancellation is recorded durably before child
        cleanup and survives coordinator restart. Poll until cancelled or
        superseded.
      operationId: browserCi.cancelRun
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            pattern: ^prj_[0-9a-z]{12,32}$
        - name: repositoryBindingId
          in: path
          required: true
          schema:
            type: string
            pattern: ^repo_[0-9a-z]{12,32}$
        - name: browserCiRunId
          in: path
          required: true
          schema:
            type: string
            pattern: ^bci_[0-9a-z]{12,32}$
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 8
            maxLength: 128
            pattern: ^[A-Za-z0-9._:-]+$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelBrowserCiRunRequest'
      responses:
        '200':
          description: Mutation result or original idempotency receipt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrowserCiRun'
        '400':
          description: Canonical error envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Canonical error envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Canonical error envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Canonical error envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: Canonical error envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Canonical error envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        default:
          description: Canonical error envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    CancelBrowserCiRunRequest:
      type: object
      properties:
        confirm:
          type: string
          pattern: ^bci_[0-9a-z]{12,32}$
      required:
        - confirm
      additionalProperties: false
    BrowserCiRun:
      type: object
      properties:
        schemaVersion:
          type: number
          enum:
            - 1
        browserCiRunId:
          type: string
          pattern: ^bci_[0-9a-z]{12,32}$
        organizationId:
          type: string
          pattern: ^org_[0-9a-z]{12,32}$
        projectId:
          type: string
          pattern: ^prj_[0-9a-z]{12,32}$
        repositoryBindingId:
          type: string
          pattern: ^repo_[0-9a-z]{12,32}$
        configVersion:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        pullRequestNumber:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        baseRevision:
          type: string
          pattern: ^[0-9a-f]{40}$
        candidateRevision:
          type: string
          pattern: ^[0-9a-f]{40}$
        state:
          type: string
          enum:
            - queued
            - running
            - cancelling
            - passed
            - failed
            - cancelled
            - superseded
        selection:
          type: object
          properties:
            mode:
              type: string
              enum:
                - all
                - change_aware
            changedFilesComplete:
              type: boolean
            fallbackReason:
              type: string
              enum:
                - disabled
                - incomplete_diff
                - invalid_path
                - global_change
                - unmapped_change
                - no_selected_tests
                - empty_diff
            selected:
              maxItems: 100
              type: array
              items:
                type: object
                properties:
                  testId:
                    type: string
                    pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,95}$
                  reason:
                    type: string
                    enum:
                      - all
                      - always
                      - unmapped_test
                      - changed_path
                  matchedPaths:
                    maxItems: 100
                    type: array
                    items:
                      type: string
                required:
                  - testId
                  - reason
                  - matchedPaths
                additionalProperties: false
            omittedTestIds:
              maxItems: 100
              type: array
              items:
                type: string
                pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,95}$
            changedFileCount:
              type: integer
              minimum: 0
              maximum: 9007199254740991
          required:
            - mode
            - changedFilesComplete
            - selected
            - omittedTestIds
            - changedFileCount
          additionalProperties: false
        cases:
          maxItems: 100
          type: array
          items:
            type: object
            properties:
              testId:
                type: string
                pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,95}$
              testVersion:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
              runId:
                type: string
              state:
                type: string
                enum:
                  - pending
                  - queued
                  - running
                  - passed
                  - failed
                  - completed
                  - cancelled
            required:
              - testId
              - testVersion
              - state
            additionalProperties: false
        delivery:
          type: string
          enum:
            - pending
            - delivered
            - superseded
        failureCode:
          type: string
          maxLength: 100
        evidenceUrl:
          type: string
          format: uri
        createdAtMs:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        updatedAtMs:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        version:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
      required:
        - schemaVersion
        - browserCiRunId
        - organizationId
        - projectId
        - repositoryBindingId
        - configVersion
        - pullRequestNumber
        - baseRevision
        - candidateRevision
        - state
        - selection
        - cases
        - delivery
        - evidenceUrl
        - createdAtMs
        - updatedAtMs
        - version
      additionalProperties: false
    ErrorEnvelope:
      type: object
      properties:
        code:
          type: string
          pattern: ^(control|world)\.[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$
        message:
          type: string
          minLength: 1
        correlationId:
          type: string
          minLength: 1
        retryable:
          type: boolean
        retryAfterMs:
          type: integer
          exclusiveMinimum: 0
          maximum: 9007199254740991
        operationId:
          type: string
        source:
          type: string
          enum:
            - platform
            - simulated_provider
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              code:
                type: string
              message:
                type: string
            required:
              - path
              - code
              - message
            additionalProperties: false
        details:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        evidence:
          type: object
          properties:
            sessionId:
              type: string
            runId:
              type: string
            journalSeq:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            buildHash:
              type: string
          additionalProperties: false
      required:
        - code
        - message
        - correlationId
        - retryable
        - source
      additionalProperties: true
  securitySchemes:
    controlCredential:
      type: http
      scheme: bearer
      description: Opaque control credential

````