{"slug":"circleci-api","name":"CircleCI API","host":"circleci.com","site":"https://circleci.com","category":"devtools","docsUrl":null,"sources":[{"kind":"changelog","url":"https://circleci.com/changelog/"},{"kind":"openapi","url":"https://circleci.com/api/v2/openapi.json"},{"kind":"archive","url":"https://circleci.com/docs/api-intro/"}],"url":"https://www.okapi.bot/providers/circleci-api/","json":"https://www.okapi.bot/api/v1/providers/circleci-api.json","breakingChanges":[{"slug":"post-api-v1-1-project-vcs-type-username-repo-is-deprecated","api":"circleci-api","title":"POST /api/v1.1/project/:vcs-type/:username/:repo/ is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-10-07","effectiveAt":"2027-02-01","scope":null,"calls":["POST /api/v1.1/project/:vcs-type/:username/:repo"],"method":"POST","path":"/api/v1.1/project/:vcs-type/:username/:repo","source":{"url":"https://circleci.com/changelog/","kind":"changelog"},"quote":"POST /api/v1.1/project/:vcs-type/:username/:repo/","migration":"To trigger a pipeline, use POST /api/v3/runs (API v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (API v2).","migrationChange":null,"needsDecision":null,"text":{"summary":"On February 1, 2027, the POST /api/v1.1/project/:vcs-type/:username/:repo endpoint will be removed. Calls made to POST /api/v1.1/project/:vcs-type/:username/:repo after this date will fail.","migration":"To trigger a pipeline, switch to POST /api/v3/runs (API v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (API v2).","by":"writer"},"publishedAt":"2026-10-23T14:29:15.049Z","updatedAt":"2026-10-23T15:23:25.743Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/post-api-v1-1-project-vcs-type-username-repo-is-deprecated/"},{"slug":"post-api-v1-1-project-vcs-type-username-repo-build-num-retry-is-deprecated","api":"circleci-api","title":"POST /api/v1.1/project/:vcs-type/:username/:repo/:build_num/retry is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-10-07","effectiveAt":"2027-02-01","scope":null,"calls":["POST /api/v1.1/project/:vcs-type/:username/:repo/:build_num/retry"],"method":"POST","path":"/api/v1.1/project/:vcs-type/:username/:repo/:build_num/retry","source":{"url":"https://circleci.com/changelog/","kind":"changelog"},"quote":"POST /api/v1.1/project/:vcs-type/:username/:repo/:build_num/retry","migration":"To rerun, use POST /api/v3/workflows/:id/rerun (API v3) or POST /api/v2/workflow/:workflow-id/rerun (API v2).","migrationChange":null,"needsDecision":null,"text":{"summary":"On February 1, 2027, the endpoint POST /api/v1.1/project/:vcs-type/:username/:repo/:build_num/retry will be removed. Calls made to this endpoint after that date will fail.","migration":"To rerun, use POST /api/v3/workflows/:id/rerun (API v3) or POST /api/v2/workflow/:workflow-id/rerun (API v2).","by":"writer"},"publishedAt":"2026-10-23T14:29:15.049Z","updatedAt":"2026-10-23T15:23:22.957Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/post-api-v1-1-project-vcs-type-username-repo-build-num-retry-is-deprecated/"},{"slug":"post-api-v1-1-project-vcs-type-username-repo-build-num-ssh-is-deprecated","api":"circleci-api","title":"POST /api/v1.1/project/:vcs-type/:username/:repo/:build_num/ssh is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-10-07","effectiveAt":"2027-02-01","scope":null,"calls":["POST /api/v1.1/project/:vcs-type/:username/:repo/:build_num/ssh"],"method":"POST","path":"/api/v1.1/project/:vcs-type/:username/:repo/:build_num/ssh","source":{"url":"https://circleci.com/changelog/","kind":"changelog"},"quote":"POST /api/v1.1/project/:vcs-type/:username/:repo/:build_num/ssh","migration":"To rerun, use POST /api/v3/workflows/:id/rerun (API v3) or POST /api/v2/workflow/:workflow-id/rerun (API v2).","migrationChange":null,"needsDecision":null,"text":{"summary":"On February 1, 2027, the endpoint POST /api/v1.1/project/:vcs-type/:username/:repo/:build_num/ssh will be removed. Calls to this endpoint will fail after that date.","migration":"To rerun, use POST /api/v3/workflows/:id/rerun (API v3) or POST /api/v2/workflow/:workflow-id/rerun (API v2).","by":"writer"},"publishedAt":"2026-10-23T14:29:15.049Z","updatedAt":"2026-10-23T15:23:24.184Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/post-api-v1-1-project-vcs-type-username-repo-build-num-ssh-is-deprecated/"},{"slug":"post-api-v1-1-project-vcs-type-username-repo-build-is-deprecated","api":"circleci-api","title":"POST /api/v1.1/project/:vcs-type/:username/:repo/build is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-10-07","effectiveAt":"2027-02-01","scope":null,"calls":["POST /api/v1.1/project/:vcs-type/:username/:repo/build"],"method":"POST","path":"/api/v1.1/project/:vcs-type/:username/:repo/build","source":{"url":"https://circleci.com/changelog/","kind":"changelog"},"quote":"POST /api/v1.1/project/:vcs-type/:username/:repo/build","migration":"To trigger a pipeline, use POST /api/v3/runs (API v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (API v2).","migrationChange":null,"needsDecision":null,"text":{"summary":"On February 1, 2027, the POST /api/v1.1/project/:vcs-type/:username/:repo/build endpoint will be removed. After that date, requests made to this endpoint will fail. The change was announced on October 7, 2026.","migration":"To trigger a pipeline, switch to POST /api/v3/runs in API v3 or use POST /api/v2/project/:provider/:organization/:project/pipeline/run in API v2.","by":"writer"},"publishedAt":"2026-10-23T14:29:15.049Z","updatedAt":"2026-10-23T15:23:17.296Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/post-api-v1-1-project-vcs-type-username-repo-build-is-deprecated/"},{"slug":"post-api-v1-1-project-vcs-type-username-repo-tree-branch-is-deprecated","api":"circleci-api","title":"POST /api/v1.1/project/:vcs-type/:username/:repo/tree/:branch is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-10-07","effectiveAt":"2027-02-01","scope":null,"calls":["POST /api/v1.1/project/:vcs-type/:username/:repo/tree/:branch"],"method":"POST","path":"/api/v1.1/project/:vcs-type/:username/:repo/tree/:branch","source":{"url":"https://circleci.com/changelog/","kind":"changelog"},"quote":"POST /api/v1.1/project/:vcs-type/:username/:repo/tree/:branch","migration":"To trigger a pipeline, use POST /api/v3/runs (API v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (API v2).","migrationChange":null,"needsDecision":null,"text":{"summary":"On February 1, 2027, the endpoint POST /api/v1.1/project/:vcs-type/:username/:repo/tree/:branch will be removed. Calls to this endpoint will fail after that date.","migration":"To trigger a pipeline, switch to POST /api/v3/runs (API v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (API v2).","by":"writer"},"publishedAt":"2026-10-23T14:29:15.049Z","updatedAt":"2026-10-23T15:23:17.354Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/post-api-v1-1-project-vcs-type-username-repo-tree-branch-is-deprecated/"},{"slug":"post-api-v1-project-username-repo-is-deprecated","api":"circleci-api","title":"POST /api/v1/project/:username/:repo/ is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-10-07","effectiveAt":"2027-02-01","scope":null,"calls":["POST /api/v1/project/:username/:repo"],"method":"POST","path":"/api/v1/project/:username/:repo","source":{"url":"https://circleci.com/changelog/","kind":"changelog"},"quote":"POST /api/v1/project/:username/:repo/","migration":"To trigger a pipeline, use POST /api/v3/runs (API v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (API v2).","migrationChange":null,"needsDecision":null,"text":{"summary":"On February 1, 2027, the endpoint POST /api/v1/project/:username/:repo will be removed. Calls targeting this endpoint will fail after that date. The change was announced on October 7, 2026.","migration":"To trigger a pipeline, use POST /api/v3/runs (API v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (API v2).","by":"writer"},"publishedAt":"2026-10-23T14:29:15.049Z","updatedAt":"2026-10-23T15:23:20.029Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/post-api-v1-project-username-repo-is-deprecated/"},{"slug":"post-api-v1-project-username-repo-build-num-retry-is-deprecated","api":"circleci-api","title":"POST /api/v1/project/:username/:repo/:build_num/retry is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-10-07","effectiveAt":"2027-02-01","scope":null,"calls":["POST /api/v1/project/:username/:repo/:build_num/retry"],"method":"POST","path":"/api/v1/project/:username/:repo/:build_num/retry","source":{"url":"https://circleci.com/changelog/","kind":"changelog"},"quote":"POST /api/v1/project/:username/:repo/:build_num/retry","migration":"To rerun, use POST /api/v3/workflows/:id/rerun (API v3) or POST /api/v2/workflow/:workflow-id/rerun (API v2).","migrationChange":null,"needsDecision":null,"text":{"summary":"On February 1, 2027, the endpoint POST /api/v1/project/:username/:repo/:build_num/retry will be removed. Calls made to this endpoint after that date will fail.","migration":"To rerun, use POST /api/v3/workflows/:id/rerun (API v3) or POST /api/v2/workflow/:workflow-id/rerun (API v2).","by":"writer"},"publishedAt":"2026-10-23T14:29:15.049Z","updatedAt":"2026-10-23T15:23:19.930Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/post-api-v1-project-username-repo-build-num-retry-is-deprecated/"},{"slug":"post-api-v1-project-username-repo-build-num-ssh-is-deprecated","api":"circleci-api","title":"POST /api/v1/project/:username/:repo/:build_num/ssh is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-10-07","effectiveAt":"2027-02-01","scope":null,"calls":["POST /api/v1/project/:username/:repo/:build_num/ssh"],"method":"POST","path":"/api/v1/project/:username/:repo/:build_num/ssh","source":{"url":"https://circleci.com/changelog/","kind":"changelog"},"quote":"POST /api/v1/project/:username/:repo/:build_num/ssh","migration":"To rerun, use POST /api/v3/workflows/:id/rerun (API v3) or POST /api/v2/workflow/:workflow-id/rerun (API v2).","migrationChange":null,"needsDecision":null,"text":{"summary":"On February 1, 2027, the POST /api/v1/project/:username/:repo/:build_num/ssh endpoint will be removed. Calls made to POST /api/v1/project/:username/:repo/:build_num/ssh after that day will fail.","migration":"To rerun, use POST /api/v3/workflows/:id/rerun (API v3) or POST /api/v2/workflow/:workflow-id/rerun (API v2).","by":"writer"},"publishedAt":"2026-10-23T14:29:15.049Z","updatedAt":"2026-10-23T15:23:17.410Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/post-api-v1-project-username-repo-build-num-ssh-is-deprecated/"},{"slug":"post-api-v1-project-username-repo-build-is-deprecated","api":"circleci-api","title":"POST /api/v1/project/:username/:repo/build is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-10-07","effectiveAt":"2027-02-01","scope":null,"calls":["POST /api/v1/project/:username/:repo/build"],"method":"POST","path":"/api/v1/project/:username/:repo/build","source":{"url":"https://circleci.com/changelog/","kind":"changelog"},"quote":"POST /api/v1/project/:username/:repo/build","migration":"To trigger a pipeline, use POST /api/v3/runs (API v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (API v2).","migrationChange":null,"needsDecision":null,"text":{"summary":"On February 1, 2027, the POST /api/v1/project/:username/:repo/build endpoint will be removed. Calls made to this endpoint will fail after this date.","migration":"To trigger a pipeline, use POST /api/v3/runs (API v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (API v2).","by":"writer"},"publishedAt":"2026-10-23T14:29:15.049Z","updatedAt":"2026-10-23T15:23:26.152Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/post-api-v1-project-username-repo-build-is-deprecated/"},{"slug":"post-api-v1-project-username-repo-tree-branch-is-deprecated","api":"circleci-api","title":"POST /api/v1/project/:username/:repo/tree/:branch is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-10-07","effectiveAt":"2027-02-01","scope":null,"calls":["POST /api/v1/project/:username/:repo/tree/:branch"],"method":"POST","path":"/api/v1/project/:username/:repo/tree/:branch","source":{"url":"https://circleci.com/changelog/","kind":"changelog"},"quote":"POST /api/v1/project/:username/:repo/tree/:branch","migration":"To trigger a pipeline, use POST /api/v3/runs (API v3) or POST /api/v2/project/:provider/:organization/:project/pipeline/run (API v2).","migrationChange":null,"needsDecision":null,"text":{"summary":"On February 1, 2027, the endpoint POST /api/v1/project/:username/:repo/tree/:branch will be removed. Requests made to this endpoint will fail after that date. Any integration or workflow relying on this call must update to a supported pipeline trigger endpoint.","migration":"To trigger a pipeline, switch to POST /api/v3/runs in API v3 or POST /api/v2/project/:provider/:organization/:project/pipeline/run in API v2.","by":"writer"},"publishedAt":"2026-10-23T14:29:15.049Z","updatedAt":"2026-10-23T15:23:21.159Z","status":"upcoming","tone":"risk","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/post-api-v1-project-username-repo-tree-branch-is-deprecated/"},{"slug":"api-v1-1-is-deprecated","api":"circleci-api","title":"/api/v1.1 is deprecated","kind":"version_retirement","outcome":"fails","model":null,"announcedAt":null,"effectiveAt":null,"scope":null,"calls":["/api/v1.1/*"],"method":null,"path":"/api/v1.1/*","source":{"url":"https://circleci.com/docs/api-intro/","kind":"archive"},"quote":"API v1.1 is planned for End-Of-Life (EOL); CircleCI will communicate the discontinuation date in the future.","migration":"Move the calls to API v3 (or v2): for example trigger pipelines with POST /api/v2/project/{project-slug}/pipeline instead of the v1.1 project build endpoints.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:02:06.035Z","updatedAt":"2026-10-23T10:02:06.035Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/circleci-api/breaking-changes/api-v1-1-is-deprecated/"}]}