Skip to main content

self_hosted_runner_labels

Overview

Nameself_hosted_runner_labels
TypeResource
Idgithub.enterprise_admin.self_hosted_runner_labels

Fields

NameDatatypeDescription
idintegerUnique identifier of the label.
namestringName of the label.
typestringThe type of label. Read-only labels are applied automatically when the runner is configured.

Methods

NameAccessible byRequired ParamsDescription
list_labels_for_self_hosted_runner_for_enterpriseSELECTenterprise, runner_idLists all labels for a self-hosted runner configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
add_custom_labels_to_self_hosted_runner_for_enterpriseINSERTenterprise, runner_id, data__labelsAdd custom labels to a self-hosted runner configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
remove_all_custom_labels_from_self_hosted_runner_for_enterpriseDELETEenterprise, runner_idRemove all custom labels from a self-hosted runner configured in an
enterprise. Returns the remaining read-only labels from the runner.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
remove_custom_label_from_self_hosted_runner_for_enterpriseDELETEenterprise, name, runner_idRemove a custom label from a self-hosted runner configured
in an enterprise. Returns the remaining labels from the runner.

This endpoint returns a 404 Not Found status if the custom label is not
present on the runner.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
set_custom_labels_for_self_hosted_runner_for_enterpriseEXECenterprise, runner_id, data__labelsRemove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.