gitbeaker/docs/projects.md

Projects API

• List projects
• Get single project
• Create project
• Create project for user
• Edit project
• Fork project
• Star project
• Unstar project

List 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 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 single project

Create project

Creates a new project owned by the authenticated user.

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

Parameters: Create project

Create 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 project for user

Edit 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 project

Fork 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 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 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 project