Deprecation of v1 and v1.1 trigger and rerun APIs, removal on February 1, 2027

Announcements
,
1

Hi everyone,

We’re deprecating 10 legacy v1 and v1.1 API endpoints used to trigger and rerun builds. They will be removed on February 1, 2027. After that date, requests to these endpoints return HTTP 410 Gone. This applies to both CircleCI cloud and CircleCI server.

v1 endpoints:

  • POST /api/v1/project/:username/:repo/
  • POST /api/v1/project/:username/:repo/:build_num/retry
  • POST /api/v1/project/:username/:repo/:build_num/ssh
  • POST /api/v1/project/:username/:repo/build
  • POST /api/v1/project/:username/:repo/tree/:branch

v1.1 endpoints:

  • POST /api/v1.1/project/:vcs-type/:username/:repo/
  • POST /api/v1.1/project/:vcs-type/:username/:repo/:build_num/retry
  • POST /api/v1.1/project/:vcs-type/:username/:repo/:build_num/ssh
  • POST /api/v1.1/project/:vcs-type/:username/:repo/build
  • POST /api/v1.1/project/:vcs-type/:username/:repo/tree/:branch

Other v1 and v1.1 endpoints are not affected, and neither are API v2 or v3.

What to use instead

  • To trigger a pipeline, use POST /api/v3/runs (v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (v2).
  • To rerun, use POST /api/v3/workflows/:id/rerun (v3) or POST /api/v2/workflow/:workflow-id/rerun (v2). To rerun with SSH, set is_ssh_enabled (v3) or enable_ssh (v2).

Cloud customers should start with v3. CircleCI server customers should use v2, since v3 is available on cloud only.

What you need to do

  1. Find any CI scripts, internal tooling, or third-party integrations that call the endpoints above. The deprecated endpoints now return Deprecation and Sunset response headers, which can help you spot them.
  2. Update your calls to v2 or v3. Note that project addressing differs: v1 uses :username/:repo, v2 uses :provider/:organization/:project, and v3 uses UUIDs.
  3. Finish before February 1, 2027, when the endpoints are removed.

Resources

Questions or stuck on a migration? Reply in this thread, or reach out to your Technical Success Manager if you have one.