> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Projects API

> Create projects and manage source files, branches, and uploads.

Create projects and manage source files, branches, and uploads.

Review and merge source changes. Inspect files by branch, environment, or release, and manage the project’s dependencies and generated CSS artifacts.

[Projects](#projects) · [Project Labels](#project-labels) · [Account Projects](#account-projects) · [Project Templates](#project-templates) · [Project Files](#project-files) · [Project File Versions](#project-file-versions) · [File search](#file-search) · [Branches](#branches) · [Branch Approvals](#branch-approvals) · [Branch Status Checks](#branch-status-checks) · [Branch Policies](#branch-policies) · [Project Commits](#project-commits) · [Branch Files](#branch-files) · [Branch File Versions](#branch-file-versions) · [Branch File Drafts](#branch-file-drafts) · [Environment Files](#environment-files) · [Release Files](#release-files) · [Project Uploads](#project-uploads) · [Upload Folders](#upload-folders) · [Upload Grants](#upload-grants) · [Upload Visibility](#upload-visibility) · [Dependencies](#dependencies) · [Style artifacts](#style-artifacts) · [Favorites](#favorites)

## Projects

List, create, read, update, or delete projects.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects` | [GET](/docs/cloud/rest/api-reference/projects/list-projects), [POST](/docs/cloud/rest/api-reference/projects/create-project) | List projects; Create project |
| `/projects/{project_reference}` | [GET](/docs/cloud/rest/api-reference/projects/get-project), [PATCH](/docs/cloud/rest/api-reference/projects/update-project), [DELETE](/docs/cloud/rest/api-reference/projects/delete-project) | Get project; Update project; Delete project |

## Project Labels

List, create, update, or delete project labels.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/labels` | [GET](/docs/cloud/rest/api-reference/project-labels/list-project-labels), [POST](/docs/cloud/rest/api-reference/project-labels/create-project-label) | List project labels; Create project label |
| `/projects/{project_reference}/labels/{label_id}` | [PUT](/docs/cloud/rest/api-reference/project-labels/update-project-label), [DELETE](/docs/cloud/rest/api-reference/project-labels/delete-project-label) | Update project label; Delete project label |

## Account Projects

List or create projects assigned to an account.

| Endpoint | Methods | Description |
| - | - | - |
| `/accounts/{account_id}/projects` | [GET](/docs/cloud/rest/api-reference/account-projects/list-account-projects), [POST](/docs/cloud/rest/api-reference/account-projects/create-account-project) | List account projects; Create account project |

## Project Templates

List or search starter templates before creating a project.

| Endpoint | Methods | Description |
| - | - | - |
| `/templates` | [GET](/docs/cloud/rest/api-reference/project-templates/list-templates) | List templates |
| `/templates/find` | [POST](/docs/cloud/rest/api-reference/project-templates/search-templates) | Search templates |

## Project Files

List, read, write, move, delete, diff, or batch-read project files.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/files` | [GET](/docs/cloud/rest/api-reference/project-files/list-project-files) | List project files |
| `/projects/{project_reference}/files/{file_path}` | [GET](/docs/cloud/rest/api-reference/project-files/get-project-file), [PUT](/docs/cloud/rest/api-reference/project-files/upsert-project-file), [DELETE](/docs/cloud/rest/api-reference/project-files/delete-project-file) | Get project file; Upsert project file; Delete project file |
| `/projects/{project_reference}/files/{file_path}/diff` | [GET](/docs/cloud/rest/api-reference/project-files/get-project-file-diff) | Get project file diff |
| `/projects/{project_reference}/files/batch` | [POST](/docs/cloud/rest/api-reference/project-files/batch-get-project-files) | Batch get project files |
| `/projects/{project_reference}/files/move` | [POST](/docs/cloud/rest/api-reference/project-files/move-project-file) | Move project file |

## Project File Versions

List or read saved project file versions.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/files/{file_path}/versions` | [GET](/docs/cloud/rest/api-reference/project-file-versions/list-project-file-versions) | List project file versions |
| `/projects/{project_reference}/files/{file_path}/versions/{version_id}` | [GET](/docs/cloud/rest/api-reference/project-file-versions/get-project-file-version) | Get project file version |

## File search

Search project or branch files by text. Use the [Knowledge API](/docs/cloud/rest/apis/knowledge-api#vector-search) for vector search.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/files/search` | [POST](/docs/cloud/rest/api-reference/file-search/search-project-files-text) | Search project files (text) |
| `/projects/{project_reference}/branches/{branchName}/files/search` | [POST](/docs/cloud/rest/api-reference/file-search/search-branch-files-text) | Search branch files (text) |

## Branches

Create, read, delete, preview, check, or merge branches.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/branches` | [GET](/docs/cloud/rest/api-reference/branches/list-branches), [POST](/docs/cloud/rest/api-reference/branches/create-branch) | List branches; Create branch |
| `/projects/{project_reference}/branches/{branchId}` | [GET](/docs/cloud/rest/api-reference/branches/get-branch), [DELETE](/docs/cloud/rest/api-reference/branches/delete-branch) | Get branch; Delete branch |
| `/projects/{project_reference}/branches/{branchId}/merge-preview` | [GET](/docs/cloud/rest/api-reference/branches/preview-branch-merge) | Preview branch merge |
| `/projects/{project_reference}/branches/{branchId}/eligibility` | [GET](/docs/cloud/rest/api-reference/branches/check-branch-eligibility) | Check branch eligibility |
| `/projects/{project_reference}/branches/{branchId}/merge` | [POST](/docs/cloud/rest/api-reference/branches/merge-branch) | Merge branch |

## Branch Approvals

List, create, or dismiss branch approvals.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/branches/{branchId}/approvals` | [GET](/docs/cloud/rest/api-reference/branch-approvals/list-branch-approvals) | List branch approvals |
| `/projects/{project_reference}/branches/{branchId}/approvals/{approvalId}` | [DELETE](/docs/cloud/rest/api-reference/branch-approvals/dismiss-branch-approval) | Dismiss branch approval |
| `/projects/{project_reference}/branches/{branchId}/approve` | [POST](/docs/cloud/rest/api-reference/branch-approvals/approve-branch) | Approve branch |

## Branch Status Checks

List or upsert branch status checks.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/branches/{branchId}/status-checks` | [GET](/docs/cloud/rest/api-reference/branch-status-checks/list-branch-status-checks), [POST](/docs/cloud/rest/api-reference/branch-status-checks/upsert-branch-status-check) | List branch status checks; Upsert branch status check |

## Branch Policies

List, create, or delete branch policies.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/policies` | [GET](/docs/cloud/rest/api-reference/branch-policies/list-branch-policies), [POST](/docs/cloud/rest/api-reference/branch-policies/create-branch-policy) | List branch policies; Create branch policy |
| `/projects/{project_reference}/policies/{policyId}` | [DELETE](/docs/cloud/rest/api-reference/branch-policies/delete-branch-policy) | Delete branch policy |

## Project Commits

Commit project file changes.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/commit` | [POST](/docs/cloud/rest/api-reference/project-commits/commit-project-files) | Commit project files |

## Branch Files

Read branch files and diffs.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/branches/{branchName}/files` | [GET](/docs/cloud/rest/api-reference/branch-files/list-branch-files) | List branch files |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}` | [GET](/docs/cloud/rest/api-reference/branch-files/get-branch-file) | Get branch file |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/diff` | [GET](/docs/cloud/rest/api-reference/branch-files/get-branch-file-diff) | Get branch file diff |

## Branch File Versions

List or read saved branch file versions.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/versions` | [GET](/docs/cloud/rest/api-reference/branch-file-versions/list-branch-file-versions) | List branch file versions |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/versions/{version_id}` | [GET](/docs/cloud/rest/api-reference/branch-file-versions/get-branch-file-version) | Get branch file version |

## Branch File Drafts

Read, replace, or discard pending file drafts.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/drafts` | [GET](/docs/cloud/rest/api-reference/branch-file-drafts/list-pending-file-drafts) | List pending file drafts |
| `/projects/{project_reference}/branches/{branchName}/files/{filePath}/draft` | [GET](/docs/cloud/rest/api-reference/branch-file-drafts/get-branch-file-draft), [PUT](/docs/cloud/rest/api-reference/branch-file-drafts/replace-a-pending-file-draft), [DELETE](/docs/cloud/rest/api-reference/branch-file-drafts/delete-branch-file-draft) | Get branch file draft; Replace a pending file draft; Delete branch file draft |

## Environment Files

Read files and diffs from a named environment. Manage environment settings through [Environments](/docs/cloud/rest/apis/deployment-api#environments).

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/environments/{environmentName}/files` | [GET](/docs/cloud/rest/api-reference/environment-files/list-environment-files) | List environment files |
| `/projects/{project_reference}/environments/{environmentName}/files/{filePath}` | [GET](/docs/cloud/rest/api-reference/environment-files/get-environment-file) | Get environment file |
| `/projects/{project_reference}/environments/{environmentName}/files/{filePath}/diff` | [GET](/docs/cloud/rest/api-reference/environment-files/get-environment-file-diff) | Get environment file diff |

## Release Files

Read files and diffs from a specific release.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/releases/{version}/files` | [GET](/docs/cloud/rest/api-reference/release-files/list-release-files) | List release files |
| `/projects/{project_reference}/releases/{version}/files/{filePath}` | [GET](/docs/cloud/rest/api-reference/release-files/get-release-file) | Get release file |
| `/projects/{project_reference}/releases/{version}/files/{filePath}/diff` | [GET](/docs/cloud/rest/api-reference/release-files/get-release-file-diff) | Get release file diff |

## Project Uploads

List, upload, read, move, restore, delete, or get download URLs for uploads.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/uploads` | [GET](/docs/cloud/rest/api-reference/project-uploads/list-uploads), [POST](/docs/cloud/rest/api-reference/project-uploads/upload-file) | List uploads; Upload file |
| `/projects/{project_reference}/uploads/{upload_reference}` | [GET](/docs/cloud/rest/api-reference/project-uploads/get-upload), [DELETE](/docs/cloud/rest/api-reference/project-uploads/delete-upload) | Get upload; Delete upload |
| `/projects/{project_reference}/uploads/{upload_reference}/url` | [GET](/docs/cloud/rest/api-reference/project-uploads/get-upload-download-url) | Get upload download URL |
| `/projects/{project_reference}/uploads/{upload_reference}/move` | [POST](/docs/cloud/rest/api-reference/project-uploads/move-upload) | Move upload |
| `/projects/{project_reference}/uploads/{upload_reference}/restore` | [POST](/docs/cloud/rest/api-reference/project-uploads/restore-upload) | Restore upload |

## Upload Folders

Create, rename, or delete upload folders.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/uploads/folders` | [POST](/docs/cloud/rest/api-reference/upload-folders/create-folder) | Create folder |
| `/projects/{project_reference}/uploads/folders/{path}` | [DELETE](/docs/cloud/rest/api-reference/upload-folders/delete-folder) | Delete folder |
| `/projects/{project_reference}/uploads/folders/{path}/rename` | [POST](/docs/cloud/rest/api-reference/upload-folders/rename-folder) | Rename folder |

## Upload Grants

List, set, or revoke upload grants.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/uploads/grants/{path}` | [GET](/docs/cloud/rest/api-reference/upload-grants/list-grants), [PUT](/docs/cloud/rest/api-reference/upload-grants/set-grants) | List grants; Set grants |
| `/projects/{project_reference}/uploads/grants/{path}/{user_id}` | [DELETE](/docs/cloud/rest/api-reference/upload-grants/revoke-grant) | Revoke grant |

## Upload Visibility

Set or remove upload path visibility.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/uploads/visibility/{path}` | [PUT](/docs/cloud/rest/api-reference/upload-visibility/set-path-visibility), [DELETE](/docs/cloud/rest/api-reference/upload-visibility/remove-path-visibility) | Set path visibility; Remove path visibility |

## Dependencies

Resolve and pin project dependencies. Read recent dependency metadata to inspect the recorded configuration.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/dependencies/history` | [GET](/docs/cloud/rest/api-reference/dependencies/get-recent-project-dependency-metadata) | Get recent project dependency metadata |
| `/projects/{project_reference}/dependencies/resolve` | [POST](/docs/cloud/rest/api-reference/dependencies/resolve-and-pin-project-dependencies) | Resolve and pin project dependencies |

## Style artifacts

Read or register the current CSS artifact and request its background build. Select the project and style profile in the request.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/style-artifacts/current` | [GET](/docs/cloud/rest/api-reference/style-artifacts/resolve-current-project-style-artifact), [PUT](/docs/cloud/rest/api-reference/style-artifacts/register-current-project-style-artifact) | Resolve current project style artifact; Register current project style artifact |
| `/projects/{project_reference}/style-artifacts/current/builds` | [POST](/docs/cloud/rest/api-reference/style-artifacts/ensure-current-project-style-artifact-build) | Ensure current project style artifact build |

## Favorites

List, add, or remove favorite projects for the current user. Favorites do not grant project access.

| Endpoint | Methods | Description |
| - | - | - |
| `/favorites` | [GET](/docs/cloud/rest/api-reference/favorites/list-favorites) | List favorites |
| `/favorites/{project_reference}` | [GET](/docs/cloud/rest/api-reference/favorites/check-favorite), [POST](/docs/cloud/rest/api-reference/favorites/create-favorite), [DELETE](/docs/cloud/rest/api-reference/favorites/delete-favorite) | Check favorite; Create favorite; Delete favorite |

[Back to REST API reference](/docs/cloud/rest)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.