It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Set runner logging settings Platform - configuration - Store »

› › › ›

Set runner roles

edit

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)

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

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

Request example

edit

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

« Set runner logging settings Platform - configuration - Store »