{
  "opencollection": "1.0.0",
  "info": {
    "name": "CircleCI REST API v1",
    "version": "1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Circle-Token",
      "value": "{{Circle-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "User",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get authenticated user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://circleci.com/api/v1.1/me"
          },
          "docs": "Returns information about the currently authenticated user, including name, login, and avatar URL."
        }
      ]
    },
    {
      "info": {
        "name": "Project",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List followed projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://circleci.com/api/v1.1/projects"
          },
          "docs": "Returns a list of all projects the authenticated user follows, including recent build summaries for each project."
        },
        {
          "info": {
            "name": "Follow a project",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/follow",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              }
            ]
          },
          "docs": "Follows a project, adding it to the authenticated user's list of followed projects."
        }
      ]
    },
    {
      "info": {
        "name": "Build",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List builds for a project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter builds by status"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of builds to return (max 100)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination"
              }
            ]
          },
          "docs": "Returns a list of the most recent builds for the specified project, with optional filtering by branch."
        },
        {
          "info": {
            "name": "Trigger a new build",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Triggers a new build for the specified project. Optionally specify a branch, revision, or build parameters."
        },
        {
          "info": {
            "name": "Trigger a build on a branch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/tree/:branch",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              },
              {
                "name": "branch",
                "value": "",
                "type": "path",
                "description": "The branch to build"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Triggers a new build on the specified branch of the project."
        },
        {
          "info": {
            "name": "Get build details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/:build_num",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              },
              {
                "name": "build_num",
                "value": "",
                "type": "path",
                "description": "The build number"
              }
            ]
          },
          "docs": "Returns detailed information about a specific build, including its status, steps, and timing information."
        },
        {
          "info": {
            "name": "Retry a build",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/retry",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              },
              {
                "name": "build_num",
                "value": "",
                "type": "path",
                "description": "The build number"
              }
            ]
          },
          "docs": "Retries a build using the same configuration and revision as the original build."
        },
        {
          "info": {
            "name": "Cancel a build",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/cancel",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              },
              {
                "name": "build_num",
                "value": "",
                "type": "path",
                "description": "The build number"
              }
            ]
          },
          "docs": "Cancels a running build."
        },
        {
          "info": {
            "name": "List recent builds across all projects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://circleci.com/api/v1.1/recent-builds",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of builds to return (max 100)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination"
              }
            ]
          },
          "docs": "Returns a list of the most recent builds across all followed projects for the authenticated user."
        }
      ]
    },
    {
      "info": {
        "name": "Artifact",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List artifacts for a build",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/artifacts",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              },
              {
                "name": "build_num",
                "value": "",
                "type": "path",
                "description": "The build number"
              }
            ]
          },
          "docs": "Returns a list of artifacts produced by the specified build."
        },
        {
          "info": {
            "name": "List latest build artifacts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/latest/artifacts",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              },
              {
                "name": "branch",
                "value": "",
                "type": "query",
                "description": "Filter artifacts by branch name"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter artifacts by status"
              }
            ]
          },
          "docs": "Returns artifacts from the latest build of the project, optionally filtered by branch."
        }
      ]
    },
    {
      "info": {
        "name": "Test Metadata",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List test metadata for a build",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/tests",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              },
              {
                "name": "build_num",
                "value": "",
                "type": "path",
                "description": "The build number"
              }
            ]
          },
          "docs": "Returns test metadata collected from the specified build, sourced from JUnit XML or similar test result files."
        }
      ]
    },
    {
      "info": {
        "name": "SSH Key",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add an SSH key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/ssh-key",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds an SSH key to the specified project for use in builds."
        },
        {
          "info": {
            "name": "List checkout keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/checkout-key",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              }
            ]
          },
          "docs": "Returns a list of checkout keys for the specified project."
        },
        {
          "info": {
            "name": "Create a checkout key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/checkout-key",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new checkout key for the specified project."
        },
        {
          "info": {
            "name": "Get a checkout key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/checkout-key/:fingerprint",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              },
              {
                "name": "fingerprint",
                "value": "",
                "type": "path",
                "description": "The fingerprint of the checkout key"
              }
            ]
          },
          "docs": "Returns a checkout key by its fingerprint."
        },
        {
          "info": {
            "name": "Delete a checkout key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/checkout-key/:fingerprint",
            "params": [
              {
                "name": "vcs-type",
                "value": "",
                "type": "path",
                "description": "The version control system type"
              },
              {
                "name": "username",
                "value": "",
                "type": "path",
                "description": "The organization or user name"
              },
              {
                "name": "project",
                "value": "",
                "type": "path",
                "description": "The repository name"
              },
              {
                "name": "fingerprint",
                "value": "",
                "type": "path",
                "description": "The fingerprint of the checkout key"
              }
            ]
          },
          "docs": "Deletes a checkout key by its fingerprint."
        }
      ]
    }
  ],
  "bundled": true
}