Set runner rolesedit

Set runner roles.

Requestedit

PUT /api/v1/platform/infrastructure/runners/{runner_id}/roles

Path parametersedit

Name Type Required Description

runner_id

string

Y

The identifier for the runner

Query parametersedit

Name Type Required Description

bless

boolean

N

Assigns the runner to the roles.

Request bodyedit

(RunnerRolesInfo) (required) The roles for the runner that you want to apply.

Responsesedit

200

(RunnerRolesInfo) The roles for the {runner_id} specified runner are assigned.

400

(BasicFailedReply) 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

(BasicFailedReply) 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

(BasicFailedReply) 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"
      }
   ]
}
'