Bulkimports 5 endpoints

POST /bulk_imports Start a new GitLab Migration

This feature was introduced in GitLab 14.2.

operationId: Bulkimports_startMigration

Request Body

required

application/x-www-form-urlencoded

schema BulkimportsStartMigrationRequest

Responses

200

Start a new GitLab Migration

400

Bad request

401

Unauthorized

404

Not found

422

Unprocessable entity

503

Service unavailable

POST /bulk_imports

GET /bulk_imports/entities List all GitLab Migrations' entities

This feature was introduced in GitLab 14.1.

operationId: Bulkimports_listEntities

Parameters

Name	In	Required	Type	Description
page	query	optional	integer	Current page number
per_page	query	optional	integer	Number of items per page
sort	query	optional	string	Return GitLab Migrations sorted in created by `asc` or `desc` order.
status	query	optional	string	Return all GitLab Migrations’ entities with specified status

Responses

200

List all GitLab Migrations’ entities

401

Unauthorized

404

Not found

503

Service unavailable

GET /bulk_imports/entities

GET /bulk_imports/{import_id} Get GitLab Migration details

This feature was introduced in GitLab 14.1.

operationId: Bulkimports_getMigrationDetails

Parameters

Name	In	Required	Type	Description
import_id	path	required	integer	The ID of user’s GitLab Migration

Responses

200

Get GitLab Migration details

401

Unauthorized

404

Not found

503

Service unavailable

GET /bulk_imports/{import_id}

GET /bulk_imports/{import_id}/entities List GitLab Migration entities

This feature was introduced in GitLab 14.1.

operationId: Bulkimports_listEntities

Parameters

Name	In	Required	Type	Description
import_id	path	required	integer	The ID of user’s GitLab Migration
status	query	optional	string	Return import entities with specified status
page	query	optional	integer	Current page number
per_page	query	optional	integer	Number of items per page

Responses

200

List GitLab Migration entities

401

Unauthorized

404

Not found

503

Service unavailable

GET /bulk_imports/{import_id}/entities

GET /bulk_imports/{import_id}/entities/{entity_id} Get GitLab Migration entity details

This feature was introduced in GitLab 14.1.

operationId: Bulkimports_getEntityDetails

Parameters

Name	In	Required	Type	Description
import_id	path	required	integer	The ID of user’s GitLab Migration
entity_id	path	required	integer	The ID of GitLab Migration entity

Responses

200

Get GitLab Migration entity details

401

Unauthorized

404

Not found

503

Service unavailable

GET /bulk_imports/{import_id}/entities/{entity_id}

Civariables 5 endpoints

GET /admin/ci/variables

List all instance-level variables

operationId: Civariables_listAllInstanceVariables

Parameters

Name	In	Required	Type	Description
page	query	optional	integer	Current page number
per_page	query	optional	integer	Number of items per page

Responses

200

List all instance-level variables

GET /admin/ci/variables

POST /admin/ci/variables

Create a new instance-level variable

operationId: Civariables_createNewInstanceLevelVariable

Request Body

required

application/json

schema CivariablesCreateNewInstanceLevelVariableRequest

Responses

201

Create a new instance-level variable

400

400 Bad Request

POST /admin/ci/variables

DELETE /admin/ci/variables/{key}

Delete an existing instance-level variable

operationId: Civariables_deleteInstanceVariable

Parameters

Name	In	Required	Type	Description
key	path	required	string	The key of a variable

Responses

204

Delete an existing instance-level variable

404

Instance Variable Not Found

DELETE /admin/ci/variables/{key}

GET /admin/ci/variables/{key}

Get the details of a specific instance-level variable

operationId: Civariables_getInstanceVariableDetails

Parameters

Name	In	Required	Type	Description
key	path	required	string	The key of a variable

Responses

200

Get the details of a specific instance-level variable

404

Instance Variable Not Found

GET /admin/ci/variables/{key}

PUT /admin/ci/variables/{key}

Update an instance-level variable

operationId: Civariables_updateInstanceVariable

Parameters

Name	In	Required	Type	Description
key	path	required	string	The key of a variable

Request Body

application/json

schema CivariablesUpdateInstanceVariableRequest

Responses

200

Update an instance-level variable

404

Instance Variable Not Found

PUT /admin/ci/variables/{key}

Clusters 5 endpoints

GET /admin/clusters List instance clusters

This feature was introduced in GitLab 13.2. Returns a list of instance clusters.

operationId: Clusters_listInstanceClusters

Responses

200

List instance clusters

403

Forbidden

GET /admin/clusters

POST /admin/clusters/add Add existing instance cluster

This feature was introduced in GitLab 13.2. Adds an existing Kubernetes instance cluster.

operationId: Clusters_addExistingInstance

Request Body

required

application/json

schema ClustersAddExistingInstanceRequest

Responses

201

Add existing instance cluster

400

Validation error

403

Forbidden

404

Not found

POST /admin/clusters/add

DELETE /admin/clusters/{cluster_id} Delete instance cluster

This feature was introduced in GitLab 13.2. Deletes an existing instance cluster. Does not remove existing resources within the connected Kubernetes cluster.

operationId: Clusters_deleteInstanceCluster

Parameters

Name	In	Required	Type	Description
cluster_id	path	required	integer	The cluster ID

Responses

204

Delete instance cluster

403

Forbidden

404

Not found

DELETE /admin/clusters/{cluster_id}

GET /admin/clusters/{cluster_id} Get a single instance cluster

This feature was introduced in GitLab 13.2. Returns a single instance cluster.

operationId: Clusters_getSingleInstance

Parameters

Name	In	Required	Type	Description
cluster_id	path	required	integer	The cluster ID

Responses

200

Get a single instance cluster

403

Forbidden

404

Not found

GET /admin/clusters/{cluster_id}

PUT /admin/clusters/{cluster_id} Edit instance cluster

This feature was introduced in GitLab 13.2. Updates an existing instance cluster.

operationId: Clusters_updateInstanceCluster

Parameters

Name	In	Required	Type	Description
cluster_id	path	required	integer	The cluster ID

Request Body

application/json

schema ClustersUpdateInstanceClusterRequest

Responses

200

Edit instance cluster

400

Validation error

403

Forbidden

404

Not found

PUT /admin/clusters/{cluster_id}

Jobs 3 endpoints

GET /projects/{id}/jobs List jobs for a project

operationId: Jobs_listForProject

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the project
scope	query	optional	array	Return all jobs with the specified statuses

Responses

200

An array of jobs

GET /projects/{id}/jobs

GET /projects/{id}/jobs/{job_id} Get a single job by ID

operationId: Jobs_getById

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the project
job_id	path	required	integer	The ID of the job

Responses

200

A single job object

GET /projects/{id}/jobs/{job_id}

POST /projects/{id}/jobs/{job_id}/play Run a manual job

operationId: Jobs_runManualJob

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The ID of the project
job_id	path	required	integer	The ID of the manual job to run
job_variables_attributes	query	optional	array	An array containing the custom variables available to the job

Responses

200

Job started successfully

POST /projects/{id}/jobs/{job_id}/play

Metadata 2 endpoints

GET /metadata Retrieve metadata information for this GitLab instance

This feature was introduced in GitLab 15.2.

operationId: Metadata_getInformation

Responses

200

Retrieve metadata information for this GitLab instance

401

Unauthorized

GET /metadata

GET /version Retrieves version information for the GitLab instance

This feature was introduced in GitLab 8.13 and deprecated in 15.5. We recommend you instead use the Metadata API.

operationId: Metadata_getVersionInfo

Responses

200

Retrieves version information for the GitLab instance

401

Unauthorized

GET /version

Migrations 1 endpoints

POST /admin/migrations/{timestamp}/mark

Mark the migration as successfully executed

operationId: Migrations_markAsExecuted

Parameters

Name	In	Required	Type	Description
timestamp	path	required	integer	The migration version timestamp

Request Body

application/json

schema MigrationsMarkAsExecutedRequest

Responses

201

201 Created

401

401 Unauthorized

403

403 Forbidden

404

404 Not found

422

You can mark only pending migrations

POST /admin/migrations/{timestamp}/mark

Planlimits 2 endpoints

GET /application/plan_limits Get current plan limits

List the current limits of a plan on the GitLab instance.

operationId: Planlimits_getCurrentLimits

Parameters

Name	In	Required	Type	Description
plan_name	query	optional	string	Name of the plan to get the limits from. Default: default.

Responses

200

Get current plan limits

401

Unauthorized

403

Forbidden

GET /application/plan_limits

PUT /application/plan_limits Change plan limits

Modify the limits of a plan on the GitLab instance.

operationId: Planlimits_modifyPlanLimits

Request Body

required

application/json

schema PlanlimitsModifyPlanLimitsRequest

Responses

200

Change plan limits

400

Bad request

401

Unauthorized

403

Forbidden

PUT /application/plan_limits