Set runner roles

edit

Set runner roles.

Request

edit

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

Path parameters

edit
Name Type Required Description

runner_id

string

Y

The identifier for the runner

Query parameters

edit
Name Type Required Description

bless

boolean

N

Assigns the runner to the roles.

Request body

edit

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

Responses

edit
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')

404

(BasicFailedReply) Unable to find the {runner_id} specified runner. Edit your request, then try again. (code: 'runners.runner_not_found')

449

(BasicFailedReply) Elevated permissions are required. (code: 'root.needs_elevated_permissions')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPUT {{hostname}}/api/v1/platform/infrastructure/runners/{runner_id}/roles \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "roles" : [
      {
         "role_name" : "string"
      }
   ]
}
'