Skip to main content
A project links a source-controlled codebase (GitHub repo or Perforce stream) to a set of build settings.

GET /projects

List projects in the current org.
Query params:
  • sourceControl=github|perforce — filter
  • limit, cursor — pagination
Response:

GET /projects/:id

Project detail, including build settings and detected .uproject info.

POST /projects/add-repo

Create a GitHub-backed project.
If uprojectPath is omitted, BuildPixel auto-detects it (depth ≤ 3).

POST /projects/add-perforce

Create a Perforce-backed project.
Requires the org’s Perforce credentials to be configured first.

PATCH /projects/:id

Update project metadata (name, description). You can’t change the source-control link via this endpoint — delete and recreate if you need to.

DELETE /projects/:id

Delete a project. Build settings are deleted with it. Past build records are retained.