Update a Runner
This request can be used to update Hybrid Runners. The following fields can be updated:
- name - The name of the Runner.
- description - The description for the runner.
- enableAutoUpdates - Enabling Automatic Updates for the Runner. Note, this cannot be set for Snowflake Runners.
- restrictedAccess - Set to true and use in conjunction with the Allow list if you wish to restrict the use of the runner to specified Environments and Projects.
- trackName - The version track name for the Runner (CURRENT or STABLE). Note, Snowflake runners cannot be updated.
Please note, all the above fields are optional
Authorizations
a valid bearer token
Path Parameters
The ID of the runner to update
Body
The updated description to be applied to the Runner
500"An AWS Runner"
Set whether the Runner should automatically update.
Note, Snowflake runners cannot have this value changed.
true
The updated name to be applied to the Runner
1 - 30"AWS Runner"
Set whether the Runner should be restricted to a specific set of projects. If set to true, the Runner will only be applicable to projects it is scoped to have access to.
Note, this cannot be set for Streaming Runners.
true
The version track name to set for the Runner. Must be either CURRENT or STABLE.
Note, Snowflake runners cannot be updated.
CURRENT, STABLE "CURRENT"
Response
Runner successfully updated
