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
  • Get a member
  • Add a member
  • Edit a member
  • Remove a member
• Project Triggers
  • List all hooks
  • Get a hook
  • Create a hook
  • Edit a hook
• Project Hooks
  • List all hooks
  • Get a hook
  • Create a hook
  • Edit a hook
• Project Branches
  • List all branches
  • Get a branch
  • Protect a branch
  • Unprotect a branch
• 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.

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.

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.

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.

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.

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.

let projectA = GitlabAPI.projects.unstar(projectId);

Parameters: Unstar a project

Remove a project

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

GitlabAPI.projects.remove(projectId);

Parameters: Remove a project

Project Members

Share a project with a group

Allow to share project with group.

GitlabAPI.projects.share(projectId, groupId, groupAccess, {
	// params
});

Parameters: Share a project with a group

Delete a shared project link within a group

Unshare the project from the group.

GitlabAPI.projects.unshare(projectId, groupId);

Parameters: Unshare a project with a group

List all members

Gets a list of project members viewable by the authenticated user.

let members = GitlabAPI.projects.listMembers(projectId);

Parameters: List all members

Get a member

Gets a member of a project.

let member = GitlabAPI.projects.showMember(projectId, memberId);

Parameters: Get a member

Add a member

Gets a member of a project.

let member = GitlabAPI.projects.addMember(projectId, {
	// params
});

Parameters: Add a member

Edit a member

Edits a member of a project.

let member = GitlabAPI.projects.editMember(projectId, {
	// params
});

Parameters: Add a member

Remove a member

Removes a member of a project.

GitlabAPI.projects.editMember(projectId, memberId);

Parameters: Remove a member

Project Triggers

List all project triggers

Allow to share project with group.

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

Parameters: List all project triggers