runner_labels

Overview

Name	runner_labels
Type	Resource
Id	github.actions.runner_labels

Fields

Name	Datatype
labels	array
total_count	integer

Methods

Name	Accessible by	Required Params	Description
list_labels_for_self_hosted_runner_for_org	SELECT	org, runner_id	Lists all labels for a self-hosted runner configured in an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations. Authenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
list_labels_for_self_hosted_runner_for_repo	SELECT	owner, repo, runner_id	Lists all labels for a self-hosted runner configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations. Authenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
add_custom_labels_to_self_hosted_runner_for_org	INSERT	org, runner_id, data__labels	Add custom labels to a self-hosted runner configured in an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations. Authenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
add_custom_labels_to_self_hosted_runner_for_repo	INSERT	owner, repo, runner_id, data__labels	Add custom labels to a self-hosted runner configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations. Authenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
remove_all_custom_labels_from_self_hosted_runner_for_org	DELETE	org, runner_id	Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner. You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations. Authenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
remove_all_custom_labels_from_self_hosted_runner_for_repo	DELETE	owner, repo, runner_id	Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner. You must authenticate using an access token with the repo scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations. Authenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
remove_custom_label_from_self_hosted_runner_for_org	DELETE	name, org, runner_id	Remove a custom label from a self-hosted runner configured in an organization. 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 admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations. Authenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
remove_custom_label_from_self_hosted_runner_for_repo	DELETE	name, owner, repo, runner_id	Remove a custom label from a self-hosted runner configured in a repository. 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 repo scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations. Authenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
set_custom_labels_for_self_hosted_runner_for_org	EXEC	org, runner_id, data__labels	Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations. Authenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.
set_custom_labels_for_self_hosted_runner_for_repo	EXEC	owner, repo, runner_id, data__labels	Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the administration permission for repositories and the organization_self_hosted_runners permission for organizations. Authenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise scope for enterprises, to use these endpoints.