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