Resource group API
You can read more about controlling the job concurrency with resource groups.
Get a specific resource group
GET /projects/:id/resource_groups/:key
Attribute | Type | Required | Description |
---|---|---|---|
id
| integer/string | yes | The ID or URL-encoded path of the project owned by the authenticated user |
key
| string | yes | The key of the resource group |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/resource_groups/production"
Example of response
{
"id": 3,
"key": "production",
"process_mode": "unordered",
"created_at": "2021-09-01T08:04:59.650Z",
"updated_at": "2021-09-01T08:04:59.650Z"
}
Edit an existing resource group
Updates an existing resource group’s properties.
It returns 200
if the resource group was successfully updated. In case of an error, a status code 400
is returned.
PUT /projects/:id/resource_groups/:key
Attribute | Type | Required | Description |
---|---|---|---|
id
| integer/string | yes | The ID or URL-encoded path of the project owned by the authenticated user |
key
| string | yes | The key of the resource group |
process_mode
| string | no | The process mode of the resource group. One of unordered , oldest_first or newest_first . Read process modes for more information.
|
curl --request PUT --data "process_mode=oldest_first" \
--header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/resource_groups/production"
Example response:
{
"id": 3,
"key": "production",
"process_mode": "oldest_first",
"created_at": "2021-09-01T08:04:59.650Z",
"updated_at": "2021-09-01T08:13:38.679Z"
}