IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Set runner roles
editSet runner rolesedit
Set runner roles.
Requestedit
PUT /api/v1/platform/infrastructure/runners/{runner_id}/roles
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The identifier for the runner |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
Assigns the runner to the roles. |
Request bodyedit
(RunnerRolesInfo
) (required) The roles for the runner that you want to apply.
Responsesedit
-
200
-
The roles for the {runner_id} specified runner are assigned.
-
400
-
There was an error while assigning the roles for the {runner_id} specified runner. Try your request again. (code:
runners.runner_set_roles_failed
)Headers
-
x-cloud-error-codes
(string
; allowed values: [runners.runner_set_roles_failed
]) - The error codes associated with the response
-
-
404
-
Unable to find the {runner_id} specified runner. Edit your request, then try again. (code:
runners.runner_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [runners.runner_not_found
]) - The error codes associated with the response
-
-
449
-
Elevated permissions are required. (code:
root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
Request exampleedit
curl -XPUT https://{{hostname}}/api/v1/platform/infrastructure/runners/{runner_id}/roles \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "roles" : [ { "role_name" : "string" } ] } '