ci.runner-groups.updateChange a runner group
Request syntax
PATCH /ci/api/runner-groups/{id}
{
"name": "string",
"repositoryIds": "array of string",
"refs": "array of string",
"protectedRefsOnly": "boolean",
"allowPullRequests": "boolean"
}Path parameters
idRequiredstring
Constraints: uuid
Request body
nameOptionalstring
New name, 1 to 100 characters (letters, digits, spaces, . _ -); 409 when another group has it; omitted: unchanged
Constraints: 1-100 chars
repositoryIdsOptionalarray of string
Replaces the repository list (up to 500 ids of this organization); null: every repository; omitted: unchanged
Constraints: uuid
May be null.
refsOptionalarray of string
Replaces the ref globs (up to 50); empty: any ref; omitted: unchanged
Constraints: 1-200 chars
protectedRefsOnlyOptionalboolean
Only branches covered by a branch protection rule; omitted: unchanged
allowPullRequestsOptionalboolean
Whether pull-request runs reach it; omitted: unchanged
Response
200 with the group as changed (fields as in the list). 400 when the body changes nothing; 409 when the new name is taken; 404 when the group, or a repository in repositoryIds, is not in this organization.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow ci:ManageRunners on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud ci runner-groups update idcurl -X PATCH "https://console.platform.deutschecloud.app/ci/api/runner-groups/id" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ci_runner-groups_update.