CircleCI REST API V2

The CircleCI REST API v2 provides programmatic access to CircleCI services for managing pipelines, projects, workflows, jobs, and users. Developers can trigger pipelines, retrieve build status, manage contexts and environment variables, and access usage reports. The API uses token-based authentication via a Circle-Token header and returns JSON responses. It supports operations for project configuration, workflow management, artifact retrieval, and insights into build performance.

OpenAPI Specification

circleci-rest-api-v2-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: CircleCI REST API v2
  description: >-
    The CircleCI REST API v2 provides programmatic access to CircleCI
    services for managing pipelines, projects, workflows, jobs, and users.
    Developers can trigger pipelines, retrieve build status, manage
    contexts and environment variables, and access usage reports. The API
    uses token-based authentication via a Circle-Token header and returns
    JSON responses. It supports operations for project configuration,
    workflow management, artifact retrieval, and insights into build
    performance.
  version: '2.0'
  contact:
    name: CircleCI Support
    url: https://support.circleci.com
  termsOfService: https://circleci.com/terms-of-service/
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
externalDocs:
  description: CircleCI API v2 Documentation
  url: https://circleci.com/docs/api/v2/
servers:
  - url: https://circleci.com/api/v2
    description: CircleCI Production API
tags:
  - name: Context
    description: >-
      Endpoints for managing contexts, which are used to secure and share
      environment variables across projects.
  - name: Insights
    description: >-
      Endpoints for retrieving workflow and job metrics, summary data,
      and test performance insights.
  - name: Job
    description: >-
      Endpoints for retrieving job details, artifacts, and test metadata
      associated with pipeline jobs.
  - name: Pipeline
    description: >-
      Endpoints for triggering, retrieving, and managing pipelines and
      their configurations.
  - name: Project
    description: >-
      Endpoints for managing project settings, checkout keys, and
      environment variables.
  - name: Schedule
    description: >-
      Endpoints for creating, updating, and managing scheduled pipeline
      triggers.
  - name: User
    description: >-
      Endpoints for retrieving information about the current user and
      collaborations.
  - name: Webhook
    description: >-
      Endpoints for creating, updating, listing, and deleting outbound
      webhook subscriptions.
  - name: Workflow
    description: >-
      Endpoints for retrieving workflow details, managing workflow status,
      and rerunning workflows.
security:
  - apiToken: []
paths:
  /me:
    get:
      operationId: getCurrentUser
      summary: Get current user
      description: >-
        Returns information about the user associated with the
        authentication token used in the request.
      tags:
        - User
      responses:
        '200':
          description: Successfully retrieved user information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized - invalid or missing authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /me/collaborations:
    get:
      operationId: getCollaborations
      summary: List collaborations
      description: >-
        Returns a list of organizations and accounts the current user
        collaborates with.
      tags:
        - User
      responses:
        '200':
          description: Successfully retrieved collaborations
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Collaboration'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /context:
    get:
      operationId: listContexts
      summary: List contexts
      description: >-
        Returns a paginated list of contexts for a given owner, which can
        be an organization or account.
      tags:
        - Context
      parameters:
        - $ref: '#/components/parameters/OwnerIdParam'
        - $ref: '#/components/parameters/OwnerSlugParam'
        - $ref: '#/components/parameters/OwnerTypeParam'
        - $ref: '#/components/parameters/PageTokenParam'
      responses:
        '200':
          description: Successfully retrieved contexts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContextList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: createContext
      summary: Create a context
      description: >-
        Creates a new context for sharing environment variables across
        projects.
      tags:
        - Context
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContextRequest'
      responses:
        '200':
          description: Successfully created context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Context'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /context/{context-id}:
    get:
      operationId: getContext
      summary: Get a context
      description: >-
        Returns a specific context by its unique identifier.
      tags:
        - Context
      parameters:
        - $ref: '#/components/parameters/ContextIdParam'
      responses:
        '200':
          description: Successfully retrieved context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Context'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Context not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: deleteContext
      summary: Delete a context
      description: >-
        Deletes a context and all of its associated environment variables.
      tags:
        - Context
      parameters:
        - $ref: '#/components/parameters/ContextIdParam'
      responses:
        '200':
          description: Successfully deleted context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Context not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /context/{context-id}/environment-variable:
    get:
      operationId: listContextEnvironmentVariables
      summary: List environment variables in a context
      description: >-
        Returns a paginated list of environment variables associated
        with a specific context.
      tags:
        - Context
      parameters:
        - $ref: '#/components/parameters/ContextIdParam'
        - $ref: '#/components/parameters/PageTokenParam'
      responses:
        '200':
          description: Successfully retrieved environment variables
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariableList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /context/{context-id}/environment-variable/{env-var-name}:
    put:
      operationId: addOrUpdateContextEnvironmentVariable
      summary: Add or update an environment variable
      description: >-
        Creates a new environment variable or updates an existing one
        within the specified context.
      tags:
        - Context
      parameters:
        - $ref: '#/components/parameters/ContextIdParam'
        - $ref: '#/components/parameters/EnvVarNameParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - value
              properties:
                value:
                  type: string
                  description: The value of the environment variable
      responses:
        '200':
          description: Successfully added or updated environment variable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariable'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: deleteContextEnvironmentVariable
      summary: Remove an environment variable
      description: >-
        Deletes an environment variable from the specified context.
      tags:
        - Context
      parameters:
        - $ref: '#/components/parameters/ContextIdParam'
        - $ref: '#/components/parameters/EnvVarNameParam'
      responses:
        '200':
          description: Successfully deleted environment variable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /pipeline:
    get:
      operationId: listPipelines
      summary: List pipelines
      description: >-
        Returns all pipelines for the most recently built projects you
        follow in the organization.
      tags:
        - Pipeline
      parameters:
        - name: org-slug
          in: query
          description: Organization slug in the form vcs-slug/org-name
          schema:
            type: string
        - name: mine
          in: query
          description: Filter to only pipelines triggered by the current user
          schema:
            type: boolean
        - $ref: '#/components/parameters/PageTokenParam'
      responses:
        '200':
          description: Successfully retrieved pipelines
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /pipeline/continue:
    post:
      operationId: continuePipeline
      summary: Continue a pipeline
      description: >-
        Continues a pipeline from a setup workflow by providing
        configuration and pipeline parameters.
      tags:
        - Pipeline
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - continuation-key
                - configuration
              properties:
                continuation-key:
                  type: string
                  description: A pipeline continuation key
                configuration:
                  type: string
                  description: A configuration string for the pipeline
                parameters:
                  type: object
                  description: Pipeline parameters as key-value pairs
                  additionalProperties: true
      responses:
        '200':
          description: Pipeline continued successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /pipeline/{pipeline-id}:
    get:
      operationId: getPipeline
      summary: Get a pipeline by ID
      description: >-
        Returns a pipeline by its unique identifier.
      tags:
        - Pipeline
      parameters:
        - $ref: '#/components/parameters/PipelineIdParam'
      responses:
        '200':
          description: Successfully retrieved pipeline
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Pipeline not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /pipeline/{pipeline-id}/config:
    get:
      operationId: getPipelineConfig
      summary: Get a pipeline's configuration
      description: >-
        Returns the configuration source for a given pipeline.
      tags:
        - Pipeline
      parameters:
        - $ref: '#/components/parameters/PipelineIdParam'
      responses:
        '200':
          description: Successfully retrieved pipeline configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineConfig'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /pipeline/{pipeline-id}/workflow:
    get:
      operationId: listPipelineWorkflows
      summary: List workflows for a pipeline
      description: >-
        Returns a paginated list of workflows associated with a
        given pipeline.
      tags:
        - Pipeline
      parameters:
        - $ref: '#/components/parameters/PipelineIdParam'
        - $ref: '#/components/parameters/PageTokenParam'
      responses:
        '200':
          description: Successfully retrieved workflows
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}:
    get:
      operationId: getProject
      summary: Get a project
      description: >-
        Returns a project by its slug, which is a triplet of the VCS type,
        organization name, and repository name.
      tags:
        - Project
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
      responses:
        '200':
          description: Successfully retrieved project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}/pipeline:
    get:
      operationId: listProjectPipelines
      summary: List project pipelines
      description: >-
        Returns a paginated list of pipelines for a given project.
      tags:
        - Pipeline
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
        - name: branch
          in: query
          description: Filter pipelines by branch name
          schema:
            type: string
        - $ref: '#/components/parameters/PageTokenParam'
      responses:
        '200':
          description: Successfully retrieved pipelines
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: triggerPipeline
      summary: Trigger a pipeline
      description: >-
        Triggers a new pipeline on the specified project. Optionally
        specify a branch, tag, or revision to build. Pipeline parameters
        can also be provided.
      tags:
        - Pipeline
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TriggerPipelineRequest'
      responses:
        '201':
          description: Pipeline triggered successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineCreation'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}/pipeline/mine:
    get:
      operationId: listMyProjectPipelines
      summary: List my project pipelines
      description: >-
        Returns a paginated list of pipelines for a project filtered
        to those triggered by the current user.
      tags:
        - Pipeline
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
        - $ref: '#/components/parameters/PageTokenParam'
      responses:
        '200':
          description: Successfully retrieved pipelines
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}/checkout-key:
    get:
      operationId: listCheckoutKeys
      summary: List checkout keys
      description: >-
        Returns a paginated list of checkout keys for a given project.
      tags:
        - Project
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
      responses:
        '200':
          description: Successfully retrieved checkout keys
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutKeyList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: createCheckoutKey
      summary: Create a checkout key
      description: >-
        Creates a new checkout key for the specified project. Only
        deploy keys and user keys are supported.
      tags:
        - Project
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - type
              properties:
                type:
                  type: string
                  enum:
                    - deploy-key
                    - user-key
                  description: The type of checkout key to create
      responses:
        '201':
          description: Checkout key created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutKey'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}/checkout-key/{fingerprint}:
    get:
      operationId: getCheckoutKey
      summary: Get a checkout key
      description: >-
        Returns a checkout key by its fingerprint.
      tags:
        - Project
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
        - $ref: '#/components/parameters/FingerprintParam'
      responses:
        '200':
          description: Successfully retrieved checkout key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutKey'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Checkout key not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: deleteCheckoutKey
      summary: Delete a checkout key
      description: >-
        Deletes a checkout key by its fingerprint.
      tags:
        - Project
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
        - $ref: '#/components/parameters/FingerprintParam'
      responses:
        '200':
          description: Successfully deleted checkout key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}/envvar:
    get:
      operationId: listProjectEnvironmentVariables
      summary: List project environment variables
      description: >-
        Returns a paginated list of masked environment variables for
        a given project.
      tags:
        - Project
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
      responses:
        '200':
          description: Successfully retrieved environment variables
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectEnvVarList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: createProjectEnvironmentVariable
      summary: Create a project environment variable
      description: >-
        Creates a new environment variable for the specified project.
      tags:
        - Project
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - value
              properties:
                name:
                  type: string
                  description: The name of the environment variable
                value:
                  type: string
                  description: The value of the environment variable
      responses:
        '201':
          description: Environment variable created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectEnvVar'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}/envvar/{name}:
    get:
      operationId: getProjectEnvironmentVariable
      summary: Get a masked environment variable
      description: >-
        Returns a masked environment variable by name for the
        specified project.
      tags:
        - Project
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
        - name: name
          in: path
          required: true
          description: The name of the environment variable
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved environment variable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectEnvVar'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Environment variable not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: deleteProjectEnvironmentVariable
      summary: Delete a project environment variable
      description: >-
        Deletes an environment variable from the specified project.
      tags:
        - Project
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
        - name: name
          in: path
          required: true
          description: The name of the environment variable
          schema:
            type: string
      responses:
        '200':
          description: Successfully deleted environment variable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}/job/{job-number}:
    get:
      operationId: getJob
      summary: Get job details
      description: >-
        Returns detailed information about a specific job, including
        its status, duration, and executor configuration.
      tags:
        - Job
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
        - $ref: '#/components/parameters/JobNumberParam'
      responses:
        '200':
          description: Successfully retrieved job details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}/job/{job-number}/cancel:
    post:
      operationId: cancelJob
      summary: Cancel a job
      description: >-
        Cancels a running job by its job number.
      tags:
        - Job
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
        - $ref: '#/components/parameters/JobNumberParam'
      responses:
        '200':
          description: Job cancelled successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}/{job-number}/artifacts:
    get:
      operationId: listJobArtifacts
      summary: List artifacts for a job
      description: >-
        Returns a paginated list of artifacts produced by a given job.
      tags:
        - Job
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
        - $ref: '#/components/parameters/JobNumberParam'
      responses:
        '200':
          description: Successfully retrieved artifacts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /project/{project-slug}/{job-number}/tests:
    get:
      operationId: listJobTests
      summary: List test metadata for a job
      description: >-
        Returns test metadata for a given job, collected from JUnit XML
        or similar test result files.
      tags:
        - Job
      parameters:
        - $ref: '#/components/parameters/ProjectSlugParam'
        - $ref: '#/components/parameters/JobNumberParam'
      responses:
        '200':
          description: Successfully retrieved test metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /workflow/{id}:
    get:
      operationId: getWorkflow
      summary: Get a workflow by ID
      description: >-
        Returns a workflow by its unique identifier, including its
        status, pipeline ID, and timing information.
      tags:
        - Workflow
      parameters:
        - $ref: '#/components/parameters/WorkflowIdParam'
      responses:
        '200':
          description: Successfully retrieved workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Workflow not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /workflow/{id}/approve/{approval_request_id}:
    post:
      operationId: approveWorkflowJob
      summary: Approve a workflow job
      description: >-
        Approves a pending approval job in a workflow, allowing the
        workflow to continue execution.
      tags:
        - Workflow
      parameters:
        - $ref: '#/components/parameters/WorkflowIdParam'
        - name: approval_request_id
          in: path
          required: true
          description: The ID of the approval request to approve
          schema:
            type: string
            format: uuid
      responses:
        '202':
          description: Approval accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /workflow/{id}/cancel:
    post:
      operationId: cancelWorkflow
      summary: Cancel a workflow
      description: >-
        Cancels a running workflow and all of its running jobs.
      tags:
        - Workflow
      parameters:
        - $ref: '#/components/parameters/WorkflowIdParam'
      responses:
        '202':
          description: Workflow cancellation accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /workflow/{id}/rerun:
    post:
      operationId: rerunWorkflow
      summary: Rerun a workflow
      description: >-
        Reruns a workflow. Optionally, specific jobs can be selected
        for rerun, and SSH access can be enabled for debugging.
      tags:
        - Workflow
      parameters:
        - $ref: '#/components/parameters/WorkflowIdParam'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                jobs:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    List of job IDs to rerun. If empty, all jobs
                    will be rerun.

# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/circleci/refs/heads/main/openapi/circleci-rest-api-v2-openapi.yml