The basic workflow for creating and using Projects is described below. A Platform Admin can perform all these actions, and many can also be performed by Project Admins. For more details, refer to individual APIs.
Project Management Procedures
# | Procedures | Using Platform UI | Using APIs |
---|---|---|---|
1 | Create a project / assign project name, key, storage quota, admin privileges | POST ${baseUrl}/access/api/v1/projects | |
2 | Get a project | GET ${baseUrl}/access/api/v1/projects/{project_key} | |
3 | View projects / get project list | GET ${baseUrl}/access/api/v1/projects | |
4 | Modify a project | Update Existing Project Properties PUT ${baseUrl}/access/api/v1/projects/{project_key} | |
5 | Update a user in a project | PUT ${baseUrl}/access/api/v1/projects/{project_key} | |
6 | Manage storage quotas | POST ${baseUrl}/access/api/v1/projects | |
7 | Assign repositories to projects (assign ownership of repository to project) | PUT /v1/projects/_/attach/repositories/{repo_name}/{target_project_key}?force=true/false | |
8 | Share a repository with a project | Share Repository with Target Project PUT /v1/projects/_/share/repositories/{repo_name}/{target_project_key} | |
9 | Share repositories with multiple projects | Not applicable. | |
10 | Share a repository with all projects | Share Repository with All Projects PUT /v1/projects/_/share/repositories/{repo_name} | |
11 | Move a repository to a project | PUT /v1/projects/_/attach/repositories/{repo_name}/{target_project_key}?force=true/false | |
12 | Share resources with projects | POST ${baseUrl}/access/api/v1/projects | |
13 | Unassign a project from a repository | Unassign a Project from a Repository DELETE ’${baseUrl}/access/api/v1/projects/_/attach/repositories/{repo_name} | |
14 | Unshare a repository with a project | Unshare Repository with Target Project DELETE /v1/projects/_/share/repositories/{repo_name}/{target_project_key} | |
16 | Unshare a repository with all projects | Unshare Repository with All Projects DELETE /v1/projects/_/share/repositories/{repo_name}/{target_project_key} | |
17 | Delete a project | DELETE ${baseUrl}/access/api/v1/projects/{project_key} |