From febb63c5ba22e050c8713123dbd9ae15b554b4a8 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:40:43 -0700 Subject: [PATCH] Update OpenAPI Description (#43264) --- .../fine-grained-pat-permissions.json | 9 + .../data/fpt-2022-11-28/fine-grained-pat.json | 6 + .../server-to-server-permissions.json | 11 + .../fpt-2022-11-28/server-to-server-rest.json | 6 + .../fpt-2022-11-28/user-to-server-rest.json | 6 + .../ghae/fine-grained-pat-permissions.json | 9 + .../data/ghae/fine-grained-pat.json | 6 + .../ghae/server-to-server-permissions.json | 11 + .../data/ghae/server-to-server-rest.json | 6 + .../data/ghae/user-to-server-rest.json | 6 + .../fine-grained-pat-permissions.json | 9 + .../ghec-2022-11-28/fine-grained-pat.json | 6 + .../server-to-server-permissions.json | 11 + .../server-to-server-rest.json | 6 + .../ghec-2022-11-28/user-to-server-rest.json | 6 + src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 322 ++++++++++++------ src/rest/data/ghae/schema.json | 162 +++++++-- src/rest/data/ghec-2022-11-28/schema.json | 322 ++++++++++++------ .../data/ghes-3.10-2022-11-28/schema.json | 120 ++++--- src/rest/data/ghes-3.6/schema.json | 95 ++++-- src/rest/data/ghes-3.7/schema.json | 95 ++++-- src/rest/data/ghes-3.8/schema.json | 115 ++++--- src/rest/data/ghes-3.9-2022-11-28/schema.json | 117 ++++--- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 60 ++-- src/webhooks/data/ghec/schema.json | 60 ++-- src/webhooks/lib/config.json | 2 +- 28 files changed, 1062 insertions(+), 526 deletions(-) diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index dcd73d2a89ea..73f5dce2eb5c 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -1741,6 +1741,15 @@ "additional-permissions": [], "access": "write" }, + { + "category": "actions", + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", + "additional-permissions": [], + "access": "write" + }, { "category": "actions", "slug": "list-jobs-for-a-workflow-run", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index 1dcecc51aacc..99528a7b8b42 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -528,6 +528,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" }, + { + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index 7a096f7dd3f5..ded4429fa05d 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -2193,6 +2193,17 @@ "server-to-server": true, "additional-permissions": [] }, + { + "category": "actions", + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "actions", "slug": "list-jobs-for-a-workflow-run", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 79523d632133..9226f1bcdb19 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -534,6 +534,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule" }, + { + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index b8dea6648f72..871cdc5f2a2e 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -528,6 +528,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" }, + { + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", diff --git a/src/github-apps/data/ghae/fine-grained-pat-permissions.json b/src/github-apps/data/ghae/fine-grained-pat-permissions.json index f30068f07af7..45d87dcaa20d 100644 --- a/src/github-apps/data/ghae/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghae/fine-grained-pat-permissions.json @@ -1039,6 +1039,15 @@ "additional-permissions": [], "access": "write" }, + { + "category": "actions", + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", + "additional-permissions": [], + "access": "write" + }, { "category": "actions", "slug": "list-jobs-for-a-workflow-run", diff --git a/src/github-apps/data/ghae/fine-grained-pat.json b/src/github-apps/data/ghae/fine-grained-pat.json index aefc44eaf69c..ca4b6575768c 100644 --- a/src/github-apps/data/ghae/fine-grained-pat.json +++ b/src/github-apps/data/ghae/fine-grained-pat.json @@ -336,6 +336,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" }, + { + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", diff --git a/src/github-apps/data/ghae/server-to-server-permissions.json b/src/github-apps/data/ghae/server-to-server-permissions.json index 5b78b7e9f1cb..b98fd4873360 100644 --- a/src/github-apps/data/ghae/server-to-server-permissions.json +++ b/src/github-apps/data/ghae/server-to-server-permissions.json @@ -1247,6 +1247,17 @@ "server-to-server": true, "additional-permissions": [] }, + { + "category": "actions", + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "actions", "slug": "list-jobs-for-a-workflow-run", diff --git a/src/github-apps/data/ghae/server-to-server-rest.json b/src/github-apps/data/ghae/server-to-server-rest.json index eeaf919c98af..c0076128ba7d 100644 --- a/src/github-apps/data/ghae/server-to-server-rest.json +++ b/src/github-apps/data/ghae/server-to-server-rest.json @@ -336,6 +336,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" }, + { + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", diff --git a/src/github-apps/data/ghae/user-to-server-rest.json b/src/github-apps/data/ghae/user-to-server-rest.json index 074b4801e98a..013fc98e4ed9 100644 --- a/src/github-apps/data/ghae/user-to-server-rest.json +++ b/src/github-apps/data/ghae/user-to-server-rest.json @@ -336,6 +336,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" }, + { + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index a988b571a788..2e890042f88f 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -2399,6 +2399,15 @@ "additional-permissions": [], "access": "write" }, + { + "category": "actions", + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", + "additional-permissions": [], + "access": "write" + }, { "category": "actions", "slug": "list-jobs-for-a-workflow-run", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index 0f5c43a875ec..e0b6a7e5f125 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -618,6 +618,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" }, + { + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index c5a0f0b4bbb6..6600488afb43 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -2987,6 +2987,17 @@ "server-to-server": true, "additional-permissions": [] }, + { + "category": "actions", + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, { "category": "actions", "slug": "list-jobs-for-a-workflow-run", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 38505d928e5d..567e0f4b6953 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -624,6 +624,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule" }, + { + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index 5f943767f48b..6380f82a7430 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -618,6 +618,12 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel" }, + { + "slug": "force-cancel-a-workflow-run", + "subcategory": "workflow-runs", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel" + }, { "slug": "list-jobs-for-a-workflow-run", "subcategory": "workflow-jobs", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index e26d27a32d16..cc03cff15404 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "b8dafbe912a3be421d21346faa2b29bf15e6f84d" + "sha": "1b91b04f33ca9cd793951478139283ed4f540421" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 99a871562c19..e8db26345d8e 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -12610,7 +12610,7 @@ } ], "previews": [], - "descriptionHTML": "
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables.\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables.\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git
extension. The name is not case sensitive.
The unique identifier of the workflow run.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "run_id": "RUN_ID" + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "Response
", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + ], + "previews": [], + "descriptionHTML": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always()
condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Accepted
" + }, + { + "httpStatusCode": "409", + "description": "Conflict
" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -230872,6 +230950,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -231050,6 +231129,13 @@ "MDQ6R2F0ZTM3NTU=" ] }, + "prevent_self_review": { + "type": "boolean", + "description": "Whether deployments to this environment can be approved by the user who created the deployment.", + "examples": [ + false + ] + }, "type": { "type": "string", "examples": [ @@ -231608,6 +231694,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -231772,6 +231859,13 @@ "MDQ6R2F0ZTM3NTU=" ] }, + "prevent_self_review": { + "type": "boolean", + "description": "Whether deployments to this environment can be approved by the user who created the deployment.", + "examples": [ + false + ] + }, "type": { "type": "string", "examples": [ @@ -232394,6 +232488,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -232558,6 +232653,13 @@ "MDQ6R2F0ZTM3NTU=" ] }, + "prevent_self_review": { + "type": "boolean", + "description": "Whether deployments to this environment can be approved by the user who created the deployment.", + "examples": [ + false + ] + }, "type": { "type": "string", "examples": [ @@ -332358,7 +332460,7 @@ } ], "previews": [], - "descriptionHTML": "Returns all community profile metrics for a repository. The repository cannot be a fork.
\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\nThe health_percentage
score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe health_percentage
is 100
. If only one is present, then the\nhealth_percentage
is 25
.
content_reports_enabled
is only returned for organization-owned repositories.
Returns all community profile metrics for a repository. The repository cannot be a fork.
\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\nThe health_percentage
score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"
content_reports_enabled
is only returned for organization-owned repositories.
Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -362894,7 +362996,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -362926,7 +363028,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -363001,7 +363103,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -363052,7 +363154,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -363804,7 +363906,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -363820,7 +363922,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -363851,7 +363953,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -363917,7 +364019,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -363968,7 +364070,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -364698,7 +364800,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -364714,7 +364816,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -364745,7 +364847,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -364811,7 +364913,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -364862,7 +364964,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -365413,7 +365515,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -365432,7 +365534,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -365464,7 +365566,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -365539,7 +365641,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -365590,7 +365692,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -366343,7 +366445,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -366359,7 +366461,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -366390,7 +366492,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -366456,7 +366558,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -366507,7 +366609,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -367636,7 +367738,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -484542,7 +484644,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -484574,7 +484676,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -484649,7 +484751,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -484700,7 +484802,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -485433,7 +485535,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -485449,7 +485551,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -485480,7 +485582,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -485546,7 +485648,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -485597,7 +485699,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -486337,7 +486439,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -486353,7 +486455,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -486384,7 +486486,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -486450,7 +486552,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -486501,7 +486603,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -486987,7 +487089,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -487006,7 +487108,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -487038,7 +487140,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -487113,7 +487215,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -487164,7 +487266,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -487898,7 +488000,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -487914,7 +488016,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -487945,7 +488047,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -488011,7 +488113,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -488062,7 +488164,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -552811,7 +552913,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Accepted
" + }, + { + "httpStatusCode": "409", + "description": "Conflict
" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel", + "title": "Force cancel a workflow run", + "category": "actions", + "subcategory": "workflow-runs", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git
extension. The name is not case sensitive.
The unique identifier of the workflow run.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "run_id": "RUN_ID" + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "Response
", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + ], + "previews": [], + "descriptionHTML": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always()
condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables.\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables.\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git
extension. The name is not case sensitive.
The unique identifier of the workflow run.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "run_id": "RUN_ID" + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "Response
", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + ], + "previews": [], + "descriptionHTML": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always()
condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Accepted
" + }, + { + "httpStatusCode": "409", + "description": "Conflict
" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -242581,6 +242659,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -242759,6 +242838,13 @@ "MDQ6R2F0ZTM3NTU=" ] }, + "prevent_self_review": { + "type": "boolean", + "description": "Whether deployments to this environment can be approved by the user who created the deployment.", + "examples": [ + false + ] + }, "type": { "type": "string", "examples": [ @@ -243317,6 +243403,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -243481,6 +243568,13 @@ "MDQ6R2F0ZTM3NTU=" ] }, + "prevent_self_review": { + "type": "boolean", + "description": "Whether deployments to this environment can be approved by the user who created the deployment.", + "examples": [ + false + ] + }, "type": { "type": "string", "examples": [ @@ -244103,6 +244197,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -244267,6 +244362,13 @@ "MDQ6R2F0ZTM3NTU=" ] }, + "prevent_self_review": { + "type": "boolean", + "description": "Whether deployments to this environment can be approved by the user who created the deployment.", + "examples": [ + false + ] + }, "type": { "type": "string", "examples": [ @@ -351169,7 +351271,7 @@ } ], "previews": [], - "descriptionHTML": "Returns all community profile metrics for a repository. The repository cannot be a fork.
\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\nThe health_percentage
score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe health_percentage
is 100
. If only one is present, then the\nhealth_percentage
is 25
.
content_reports_enabled
is only returned for organization-owned repositories.
Returns all community profile metrics for a repository. The repository cannot be a fork.
\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\nThe health_percentage
score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"
content_reports_enabled
is only returned for organization-owned repositories.
Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -385190,7 +385292,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -385222,7 +385324,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -385297,7 +385399,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -385348,7 +385450,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -386100,7 +386202,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -386116,7 +386218,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -386147,7 +386249,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -386213,7 +386315,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -386264,7 +386366,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -386994,7 +387096,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -387010,7 +387112,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -387041,7 +387143,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -387107,7 +387209,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -387158,7 +387260,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -387709,7 +387811,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -387728,7 +387830,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -387760,7 +387862,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -387835,7 +387937,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -387886,7 +387988,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -388639,7 +388741,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -388655,7 +388757,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -388686,7 +388788,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -388752,7 +388854,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -388803,7 +388905,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -389932,7 +390034,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -506966,7 +507068,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -506998,7 +507100,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -507073,7 +507175,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -507124,7 +507226,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -507857,7 +507959,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -507873,7 +507975,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -507904,7 +508006,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -507970,7 +508072,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -508021,7 +508123,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -508761,7 +508863,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -508777,7 +508879,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -508808,7 +508910,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -508874,7 +508976,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -508925,7 +509027,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -509411,7 +509513,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -509430,7 +509532,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -509462,7 +509564,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -509537,7 +509639,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -509588,7 +509690,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -510322,7 +510424,7 @@ }, { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -510338,7 +510440,7 @@ }, { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -510369,7 +510471,7 @@ }, { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -510435,7 +510537,7 @@ }, { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -510486,7 +510588,7 @@ }, { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -579289,7 +579391,7 @@ }, { "name": "hook_id", - "description": "The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables.\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables.\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all repository variables.\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables.\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all self-hosted runners configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to the config
script. The token\nexpires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN
with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated 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 a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found
status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the administration
permission for repositories and the organization_self_hosted_runners
permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the manage_runners:enterprise
scope for enterprises, to use these endpoints.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all organiation variables shared with a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables.\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all repository variables.\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in a repository.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates a repository variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes a repository variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions_variables:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Lists all environment variables.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Create an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Gets a specific variable in an environment.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environments:read
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Updates an environment variable that you can reference in a GitHub Actions workflow.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Deletes an environment variable using the variable name.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the environment:write
repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nYou must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nIf the repository is private, you must use an access token with the repo
scope.\nGitHub Apps must have the actions:write
permission to use this endpoint.
Cancels a workflow run using its id
.
You must authenticate using an access token with the repo
scope to use this endpoint.\nGitHub Apps must have the actions:write
permission to use this endpoint.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
The unique identifier of the hook.
", + "description": "The unique identifier of the hook. You can find this value in the X-GitHub-Hook-ID
header of a webhook delivery.
Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -201120,7 +201120,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -201152,7 +201152,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -201227,7 +201227,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -201278,7 +201278,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -201876,7 +201876,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -201895,7 +201895,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -201927,7 +201927,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -202002,7 +202002,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -202053,7 +202053,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -202651,7 +202651,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -202670,7 +202670,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -202702,7 +202702,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -202777,7 +202777,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -202828,7 +202828,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -203383,7 +203383,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -203402,7 +203402,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -203434,7 +203434,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -203509,7 +203509,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -203560,7 +203560,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -203927,7 +203927,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -203946,7 +203946,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -203978,7 +203978,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -204053,7 +204053,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -204104,7 +204104,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -204476,7 +204476,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -204495,7 +204495,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -204527,7 +204527,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -204602,7 +204602,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -204653,7 +204653,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index e09f6905eda6..2a64e68a9a15 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -201101,7 +201101,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -201120,7 +201120,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -201152,7 +201152,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -201227,7 +201227,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -201278,7 +201278,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -201876,7 +201876,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -201895,7 +201895,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -201927,7 +201927,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -202002,7 +202002,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -202053,7 +202053,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -202651,7 +202651,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -202670,7 +202670,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -202702,7 +202702,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -202777,7 +202777,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -202828,7 +202828,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -203383,7 +203383,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -203402,7 +203402,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -203434,7 +203434,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -203509,7 +203509,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -203560,7 +203560,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -203927,7 +203927,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -203946,7 +203946,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -203978,7 +203978,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -204053,7 +204053,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -204104,7 +204104,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], @@ -204476,7 +204476,7 @@ { "type": "object", "name": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.
", + "description": "Prevent merge commits from being pushed to matching refs.
", "isRequired": [ "type" ], @@ -204495,7 +204495,7 @@ { "type": "object", "name": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.
", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
", "isRequired": [ "type" ], @@ -204527,7 +204527,7 @@ { "type": "object", "name": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.
", + "description": "Commits pushed to matching refs must have verified signatures.
", "isRequired": [ "type" ], @@ -204602,7 +204602,7 @@ { "type": "object", "name": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.
", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
", "isRequired": [ "type" ], @@ -204653,7 +204653,7 @@ { "type": "object", "name": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.
", + "description": "Prevent users with push access from force pushing to refs.
", "isRequired": [ "type" ], diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 7a5d193ead39..6ebb613f88a7 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "b8dafbe912a3be421d21346faa2b29bf15e6f84d" + "sha": "1b91b04f33ca9cd793951478139283ed4f540421" } \ No newline at end of file