CI resource groups

Use this API to interact with resource groups.

List all resource groups

GET /api/v4/projects/{id}/resource_groups

Lists all resource groups for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`page` Query	Integer	Page number of results to retrieve Default: `1` Example: `1`
`per_page` Query	Integer	Number of items to list per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesCiResourceGroup
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Retrieve a resource group

GET /api/v4/projects/{id}/resource_groups/{key}

Retrieves a specified resource group for a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`key` Path, required	String	URL-encoded key of the resource group, for example `resource%5Fa` instead of `resource_a`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiResourceGroup
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Update a resource group

PUT /api/v4/projects/{id}/resource_groups/{key}

Updates the properties for a specified resource group. It returns 200 if the resource group was successfully updated. In case of an error, a status code 400 is returned.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`key` Path, required	String	URL-encoded key of the resource group, for example `resource%5Fa` instead of `resource_a`

Request body (application/json)

Property	Type	Description
`process_mode`	String	Process mode of the resource group. Read process modes for more information Allowed values: `unordered`, `oldest_first`, `newest_first`, `newest_ready_first`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiResourceGroup
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Retrieve current job for a resource group

GET /api/v4/projects/{id}/resource_groups/{key}/current_job

Retrieves the current job for a specified resource group in a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`key` Path, required	String	URL-encoded key of the resource group, for example `resource%5Fa` instead of `resource_a`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiJobBasic
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

List all upcoming jobs for a resource group

GET /api/v4/projects/{id}/resource_groups/{key}/upcoming_jobs

Lists all upcoming jobs for a specified resource group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	ID or URL-encoded path of the project
`key` Path, required	String	URL-encoded key of the resource group, for example `resource%5Fa` instead of `resource_a`
`page` Query	Integer	Page number of results to retrieve Default: `1` Example: `1`
`per_page` Query	Integer	Number of items to list per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	Array of APIEntitiesCiJobBasic
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesCiJobBasic

Property	Type	Description
`allow_failure`	Boolean	—
`commit`	APIEntitiesCommit	—
`coverage`	Number (float)	Example: `98.29`
`created_at`	String (date-time)	Example: `2015-12-24T15:51:21.880Z`
`duration`	Number (float)	Time spent running Example: `0.465`
`erased_at`	String (date-time)	Example: `2015-12-24T18:00:29.728Z`
`failure_reason`	String	Example: `script_failure`
`finished_at`	String (date-time)	Example: `2015-12-24T17:54:31.198Z`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `deploy_to_production`
`pipeline`	APIEntitiesCiPipelineBasic	—
`project`	Object	—
`project.ci_job_token_scope_enabled`	String	Example: `false`
`queued_duration`	Number (float)	Time spent enqueued Example: `0.123`
`ref`	String	Example: `main`
`stage`	String	Example: `deploy`
`started_at`	String (date-time)	Example: `2015-12-24T17:54:30.733Z`
`status`	String	Example: `waiting_for_resource`
`tag`	Boolean	—
`user`	APIEntitiesUser	—
`web_url`	String	Example: `https://example.com/foo/bar/-/jobs/1`

APIEntitiesCiPipelineBasic

Property	Type	Description
`created_at`	String (date-time)	Example: `2022-10-21T16:49:48.000+02:00`
`id`	Integer (int64)	Example: `1`
`iid`	Integer	Example: `2`
`project_id`	Integer (int64)	Example: `3`
`ref`	String	Example: `feature-branch`
`sha`	String	Example: `0ec9e58fdfca6cdd6652c083c9edb53abc0bad52`
`source`	String	Example: `push`
`status`	String	Example: `success`
`updated_at`	String (date-time)	Example: `2022-10-21T16:49:48.000+02:00`
`web_url`	String	Example: `https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61`

APIEntitiesCiResourceGroup

Property	Type	Description
`created_at`	String (date-time)	Example: `2021-09-01T08:04:59.650Z`
`id`	Integer (int64)	Example: `1`
`key`	String	Example: `production`
`process_mode`	String	Example: `unordered`
`updated_at`	String (date-time)	Example: `2021-09-01T08:04:59.650Z`

APIEntitiesCommit

Property	Type	Description
`author_email`	String	Example: `john@example.com`
`author_name`	String	Example: `John Smith`
`authored_date`	String (date-time)	Example: `2012-05-28T04:42:42-07:00`
`committed_date`	String (date-time)	Example: `2012-05-28T04:42:42-07:00`
`committer_email`	String	Example: `jack@example.com`
`committer_name`	String	Example: `Jack Smith`
`created_at`	String (date-time)	Example: `2017-07-26T11:08:53.000+02:00`
`extended_trailers`	Object	Example: `{"Signed-off-by":["John Doe \u003cjohndoe@gitlab.com\u003e","Jane Doe \u003cjanedoe@gitlab.com\u003e"]}`
`id`	String	Example: `2695effb5807a22ff3d138d593fd856244e155e7`
`message`	String	Example: `Initial commit`
`parent_ids`	Array of strings	Example: `["2a4b78934375d7f53875269ffd4f45fd83a84ebe"]`
`short_id`	String	Example: `2695effb`
`title`	String	Example: `Initial commit`
`trailers`	Object	Example: `{"Merged-By":"Jane Doe janedoe@gitlab.com"}`
`web_url`	String	Example: `https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746`

APIEntitiesCustomAttribute

Property	Type	Description
`key`	String	Example: `foo`
`value`	String	Example: `bar`

APIEntitiesUser

Property	Type	Description
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`bio`	String	—
`bot`	Boolean	—
`created_at`	String	—
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`discord`	String	—
`followers`	String	—
`following`	String	—
`github`	String	—
`id`	Integer (int64)	Example: `1`
`is_followed`	String	—
`job_title`	String	—
`linkedin`	String	—
`local_time`	String	—
`location`	String	—
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`organization`	String	—
`pronouns`	String	—
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`twitter`	String	—
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`
`website_url`	String	—
`work_information`	String	—

List all resource groups

Retrieve a resource group

Update a resource group

Retrieve current job for a resource group

List all upcoming jobs for a resource group

Schemas

APIEntitiesCiJobBasic

APIEntitiesCiPipelineBasic

APIEntitiesCiResourceGroup

APIEntitiesCommit

APIEntitiesCustomAttribute

APIEntitiesUser

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC compliance report

Thank you

Error

Request partner program details

Request received

Error