View as Markdown
CircleCI icon

CircleCI ACTION

Rerun Workflow

Reruns the specified workflow. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's CircleCI account once, then configure and run Rerun Workflow from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "circleci-rerun-workflow",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    circleci: { authProvisionId: "apn_xxxxxxx" },
    projectSlug: "Project Slug",
    pipelineId: "Pipeline ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Rerun Workflow inputs
Property Type Description
projectSlug Project Slug string
Project slug in the form vcs-slug/org-name/repo-name (found in Project Settings)
Required
pipelineId Pipeline ID string
The identifier of a pipeline
Required Dynamic
workflowId Workflow ID string
The identifier of a workflow
Required Dynamic
enableSsh Enable SSH boolean
Whether to enable SSH access for the triggering user on the newly-rerun job. Requires the jobs parameter to be used and so is mutually exclusive with the from_failed parameter.
Optional
fromFailed From Failed boolean
Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.
Optional
jobIds Jobs string[]
A list of job IDs to rerun
Optional Dynamic
sparseTree Sparse Tree boolean
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
circleci-rerun-workflow
Version
0.0.2
App
CircleCI
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes