Skip to main content

CircleCI API v3 Returns "404 Not Found"

What to do when you see 404 errors in the v3 API

Overview

When you call a CircleCI API v3 endpoint, and the response is 404 Not Found, the V3 returns a single error object, so the body looks like this:

{   "error": {
     "type": "<token>",
     "id": "<error-id>",
     "title": "Not Found",
     "detail": "<message>"
     }
 }

This article covers 404 responses from https://circleci.com/api/v3. For API v2, see CircleCI API v2 Returns "404 Not Found".

Solutions

Incorrect path or host

A 404 with no resource named in the message usually means the path does not match a V3 route.

  • Compare your request to the endpoint list in the API v3 reference. Check for typos, a missing /api/v3 prefix, and singular or plural mistakes (/workflows, not /workflow).

  • Do not reuse an API v2 path. V3 has no /project/{project-slug}/... routes. For example, GET /api/v3/projects/:id takes a project UUID.

  • Use https://circleci.com/api/v3. V3 is not available on CircleCI server installations. If you run CircleCI server, use API v2.

  • A deprecated endpoint keeps working until its Sunset date. After that, the route returns 410, not 404.

Related Articles
Did this answer your question?