gitbeaker/docs/projects.md

Projects API

• Basic
  • List all projects
  • Get a single project
  • Create a project
  • Create a project for user
  • Edit a project
  • Fork a project
  • Star a project
  • Unstar a project
• Project Members
  • Share project with group
  • Delete a shared project link within a group
  • List all members of a project
  • Get a member of a project
  • Add a member to a project
  • Edit a member of a project
  • Remove a member from a project
• Project Hooks
  • Share project with group
  • Delete a shared project link within a group
• Project Branches
  • Share project with group
  • Delete a shared project link within a group
• Project Search

Basic

List all projects

Get a list of visible projects for authenticated user. When accessed without authentication, only public projects are returned.

let projects = GitlabAPI.projects.all();

Parameters: List all projects

Get a single project

Get a specific project. This endpoint can be accessed without authentication if the project is publicly accessible.

// From a project ID
let projectA = GitlabAPI.projects.show(21);

// From a projects url
let projectB = GitlabAPI.projects.show('diaspora/diaspora');

Parameters: Get a single project

Create a project

Creates a new project owned by the authenticated user.

// From a project ID
let projectA = GitlabAPI.projects.create({
  // params
});

Parameters: Create a project

Create a project for user

Creates a new project owned by the specified user. Available only for admins.

// From a project ID
let projectA = GitlabAPI.projects.create({
	userId: 5,
  // params
});

Parameters: Create a project for user

Edit a project

Creates a new project owned by the specified user. Available only for admins.

// From a project ID
let projectA = GitlabAPI.projects.edit(projectId, {
  // params
});

Parameters: Edit a project

Fork a project

Forks a project into the user namespace of the authenticated user or the one provided.

// From a project ID
let projectA = GitlabAPI.projects.fork(projectId, {
  // params
});

Parameters: Fork a project

Star a project

Stars a given project. Returns status code 304 if the project is already starred.

// From a project ID
let projectA = GitlabAPI.projects.star(projectId);

Parameters: Star a project

Unstar a project

Unstars a given project. Returns status code 304 if the project is not starred.

// From a project ID
let projectA = GitlabAPI.projects.unstar(projectId);

Parameters: Unstar a project

Remove a project

Removes a project including all associated resources (issues, merge requests etc.)

// From a project ID
let projectA = GitlabAPI.projects.remove(projectId);

Parameters: Remove a project

Project Members

Share a project with a group

Allow to share project with group.

// From a project ID
let projectA = GitlabAPI.projects.share(projectId, groupId, groupAccess, {
	//options
});

Parameters: Share a project with a group