Merge branch 'main' into patch-2
This commit is contained in:
Ramya Parimi
@@ -1,38 +0,0 @@
|
||||
---
|
||||
title: Enabling unified search between GitHub Enterprise Server and GitHub.com
|
||||
intro: 'After enabling {% data variables.product.prodname_github_connect %}, you can allow search of {% data variables.product.prodname_dotcom_the_website %} from {% data variables.product.product_location_enterprise %}.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-and-github-com/
|
||||
- /enterprise/admin/guides/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-github-com/
|
||||
- /enterprise/admin/developer-workflow/enabling-unified-search-between-github-enterprise-server-and-githubcom/
|
||||
- /enterprise/admin/installation/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
- /enterprise/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
- /admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom
|
||||
permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified search between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
- GitHub Connect
|
||||
- GitHub search
|
||||
shortTitle: Enable unified search
|
||||
---
|
||||
When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location_enterprise %}.
|
||||
|
||||
Users will not be able to search {% data variables.product.product_location_enterprise %} from {% data variables.product.prodname_dotcom_the_website %}, even if they have access to both environments. Users can only search private repositories you've enabled {% data variables.product.prodname_unified_search %} for and that they have access to in the connected {% data variables.product.prodname_ghe_cloud %} organizations. For more information, see "[About searching on {% data variables.product.prodname_dotcom %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github/#searching-across-github-enterprise-and-githubcom-simultaneously)" and "[Enabling private {% data variables.product.prodname_dotcom_the_website %} repository search in your {% data variables.product.prodname_ghe_server %} account](/articles/enabling-private-github-com-repository-search-in-your-github-enterprise-server-account)."
|
||||
|
||||
Searching via the REST and GraphQL APIs does not include {% data variables.product.prodname_dotcom_the_website %} search results. Advanced search and searching for wikis in {% data variables.product.prodname_dotcom_the_website %} are not supported.
|
||||
|
||||
{% data reusables.github-connect.access-dotcom-and-enterprise %}
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.business %}
|
||||
{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}
|
||||
{% data reusables.enterprise-accounts.github-connect-tab %}
|
||||
5. Under "Users can search {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**.
|
||||
|
||||
6. Optionally, under "Users can search private repositories on {% data variables.product.prodname_dotcom_the_website %}", use the drop-down menu and click **Enabled**.
|
||||
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_dotcom_the_website %}](/enterprise/admin/guides/developer-workflow/connecting-github-enterprise-server-to-github-com)"
|
||||
@@ -31,6 +31,6 @@ Once you enable GPG verification, it will immediately take effect for all your c
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Once you have enabled GPG verification for {% data variables.product.prodname_codespaces %}, you also must append `-s` to each commit in order for it to be signed. To do this in {% data variables.product.prodname_vscode %}, ensure the "Git: Enable Commit Signing" option is enabled from the Settings.
|
||||
**Note:** Once you have enabled GPG verification for {% data variables.product.prodname_codespaces %}, you also must append `-S` to each commit in order for it to be signed. To do this in {% data variables.product.prodname_vscode %}, ensure the "Git: Enable Commit Signing" option is enabled from the Settings.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
@@ -67,7 +67,8 @@ Some of the features listed below are limited to organizations using {% data var
|
||||
| Submit reviews on pull requests | **X** | **X** | **X** | **X** | **X** |
|
||||
| View published releases | **X** | **X** | **X** | **X** | **X** |{% ifversion fpt %}
|
||||
| View [GitHub Actions workflow runs](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run) | **X** | **X** | **X** | **X** | **X** |{% endif %}
|
||||
| Edit wikis | **X** | **X** | **X** | **X** | **X** |{% ifversion fpt %}
|
||||
| Edit wikis in public repositories | **X** | **X** | **X** | **X** | **X** |
|
||||
| Edit wikis in private repositories | | | **X** | **X** | **X** |{% ifversion fpt %}
|
||||
| [Report abusive or spammy content](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam) | **X** | **X** | **X** | **X** | **X** |{% endif %}
|
||||
| Apply/dismiss labels | | **X** | **X** | **X** | **X** |
|
||||
| Create, edit, delete labels | | | **X** | **X** | **X** |
|
||||
|
||||
@@ -74,17 +74,17 @@ changelog:
|
||||
authors:
|
||||
- octocat
|
||||
categories:
|
||||
- title: Breaking Changes 🛠
|
||||
labels:
|
||||
- Semver-Major
|
||||
- breaking-change
|
||||
- title: Exciting New Features 🎉
|
||||
labels:
|
||||
- Semver-Minor
|
||||
- enhancement
|
||||
- title: Other Changes
|
||||
labels:
|
||||
- "*"
|
||||
- title: Breaking Changes 🛠
|
||||
labels:
|
||||
- Semver-Major
|
||||
- breaking-change
|
||||
- title: Exciting New Features 🎉
|
||||
labels:
|
||||
- Semver-Minor
|
||||
- enhancement
|
||||
- title: Other Changes
|
||||
labels:
|
||||
- "*"
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
@@ -92,7 +92,7 @@ changelog:
|
||||
|
||||
| Parameter | Description |Required | Value |
|
||||
| :- | :- | :- | :- |
|
||||
|`changelog` | Defines the contents within it as the custom template for your release notes.|Required. | No value accpeted.|
|
||||
|`changelog` | Defines the contents within it as the custom template for your release notes.|Required. | No value accepted.|
|
||||
|`exclude`| Creates a category of pull requests to be excluded from the release. Can be set at the top-level of the changelog to apply to all categories or applied on a per-category basis. |Optional | No value accepted.|
|
||||
|`authors`| Specifies authors to be excluded from the release.| Optional for `exclude` category.| Accepts usernames and bots as values.|
|
||||
|`categories`| Defines the nested contents as custom categories to be included in the template. |Optional | No value accepted.|
|
||||
|
||||
@@ -136,10 +136,10 @@ $ curl -i -u <em>your_username</em> {% data variables.product.api_url_pre %}/use
|
||||
|
||||
When prompted, you can enter your OAuth token, but we recommend you set up a variable for it:
|
||||
|
||||
You can use `-u "username:$token"` and set up a variable for `token` to avoid leaving your token in shell history, which should be avoided.
|
||||
You can use `-u "your_username:$token"` and set up a variable for `token` to avoid leaving your token in shell history, which should be avoided.
|
||||
|
||||
```shell
|
||||
$ curl -i -u <em>username:$token</em> {% data variables.product.api_url_pre %}/users/octocat
|
||||
$ curl -i -u <em>your_username:$token</em> {% data variables.product.api_url_pre %}/users/octocat
|
||||
|
||||
```
|
||||
|
||||
|
||||
@@ -1,256 +1,181 @@
|
||||
Provider | Supported secret | API slug
|
||||
--- | --- | ---
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Adafruit IO | Adafruit IO Key | adafruit_io_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Adobe | Adobe Device Token | adobe_device_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Adobe | Adobe Service Token | adobe_service_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Adobe | Adobe Short-Lived Access Token | adobe_short_lived_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Adobe | Adobe Device Token | adobe_device_token
|
||||
Adobe | Adobe Service Token | adobe_service_token
|
||||
Adobe | Adobe Short-Lived Access Token | adobe_short_lived_access_token
|
||||
Adobe | Adobe JSON Web Token | adobe_jwt{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Alibaba Cloud | Alibaba Cloud Access Key ID | alibaba_cloud_access_key_id{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Alibaba Cloud | Alibaba Cloud Access Key Secret | alibaba_cloud_access_key_secret{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Amazon Web Services (AWS) | Amazon AWS Access Key ID | aws_access_key_id{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Alibaba Cloud | Alibaba Cloud Access Key ID | alibaba_cloud_access_key_id
|
||||
Alibaba Cloud | Alibaba Cloud Access Key Secret | alibaba_cloud_access_key_secret
|
||||
Amazon Web Services (AWS) | Amazon AWS Access Key ID | aws_access_key_id
|
||||
Amazon Web Services (AWS) | Amazon AWS Secret Access Key | aws_secret_access_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
Amazon Web Services (AWS) | Amazon AWS Session Token | aws_session_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.2 %}
|
||||
Amazon Web Services (AWS) | Amazon AWS Session Token | aws_session_token
|
||||
Amazon Web Services (AWS) | Amazon AWS Temporary Access Key ID | aws_temporary_access_key_id{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Asana | Asana Personal Access Token | asana_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Atlassian | Atlassian API Token | atlassian_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Atlassian | Atlassian API Token | atlassian_api_token
|
||||
Atlassian | Atlassian JSON Web Token | atlassian_jwt{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Atlassian | Bitbucket Server Personal Access Token | bitbucket_server_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Azure | Azure DevOps Personal Access Token | azure_devops_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Azure | Azure SAS Token | azure_sas_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Azure | Azure Service Management Certificate | azure_management_certificate{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Azure | Azure SQL Connection String | azure_sql_connection_string{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Azure | Azure DevOps Personal Access Token | azure_devops_personal_access_token
|
||||
Azure | Azure SAS Token | azure_sas_token
|
||||
Azure | Azure Service Management Certificate | azure_management_certificate
|
||||
Azure | Azure SQL Connection String | azure_sql_connection_string
|
||||
Azure | Azure Storage Account Key | azure_storage_account_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.2 %}
|
||||
Beamer | Beamer API Key | beamer_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Checkout.com | Checkout.com Production Secret Key | checkout_production_secret_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Checkout.com | Checkout.com Production Secret Key | checkout_production_secret_key
|
||||
Checkout.com | Checkout.com Test Secret Key | checkout_test_secret_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Clojars | Clojars Deploy Token | clojars_deploy_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
CloudBees CodeShip | CloudBees CodeShip Credential | codeship_credential{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.2 %}
|
||||
Contentful | Contentful Personal Access Token | contentful_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Databricks | Databricks Access Token | databricks_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Databricks | Databricks Access Token | databricks_access_token
|
||||
Discord | Discord Bot Token | discord_bot_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
Doppler | Doppler Personal Token | doppler_personal_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
Doppler | Doppler Service Token | doppler_service_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
Doppler | Doppler CLI Token | doppler_cli_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae %}
|
||||
Doppler | Doppler Personal Token | doppler_personal_token
|
||||
Doppler | Doppler Service Token | doppler_service_token
|
||||
Doppler | Doppler CLI Token | doppler_cli_token
|
||||
Doppler | Doppler SCIM Token | doppler_scim_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Doppler | Doppler Audit Token | doppler_audit_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Dropbox | Dropbox Access Token | dropbox_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Dropbox | Dropbox Access Token | dropbox_access_token
|
||||
Dropbox | Dropbox Short Lived Access Token | dropbox_short_lived_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Duffel | Duffel Live Access Token | duffel_live_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Duffel | Duffel Live Access Token | duffel_live_access_token
|
||||
Duffel | Duffel Test Access Token | duffel_test_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae %}
|
||||
Dynatrace | Dynatrace Access Token | dynatrace_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Dynatrace | Dynatrace Internal Token | dynatrace_internal_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
EasyPost | EasyPost Production API Key | easypost_production_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
EasyPost | EasyPost Test API Key | easypost_test_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Facebook | Facebook Access Token | facebook_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
EasyPost | EasyPost Production API Key | easypost_production_api_key
|
||||
EasyPost | EasyPost Test API Key | easypost_test_api_key
|
||||
Facebook | Facebook Access Token | facebook_access_token
|
||||
Fastly | Fastly API Token | fastly_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Finicity | Finicity App Key | finicity_app_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Flutterwave | Flutterwave Live API Secret Key | flutterwave_live_api_secret_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Flutterwave | Flutterwave Live API Secret Key | flutterwave_live_api_secret_key
|
||||
Flutterwave | Flutterwave Test API Secret Key | flutterwave_test_api_secret_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Frame.io | Frame.io JSON Web Token | frameio_jwt{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Frame.io | Frame.io JSON Web Token | frameio_jwt
|
||||
Frame.io| Frame.io Developer Token | frameio_developer_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.2 %}
|
||||
FullStory | FullStory API Key | fullstory_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
GitHub | GitHub Personal Access Token | github_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
GitHub | GitHub OAuth Access Token | github_oauth_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
GitHub | GitHub Refresh Token | github_refresh_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
GitHub | GitHub Personal Access Token | github_personal_access_token
|
||||
GitHub | GitHub OAuth Access Token | github_oauth_access_token
|
||||
GitHub | GitHub Refresh Token | github_refresh_token
|
||||
GitHub | GitHub App Installation Access Token | github_app_installation_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
GitHub | GitHub SSH Private Key | github_ssh_private_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
GoCardless | GoCardless Live Access Token | gocardless_live_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
GitHub | GitHub SSH Private Key | github_ssh_private_key
|
||||
GoCardless | GoCardless Live Access Token | gocardless_live_access_token
|
||||
GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.2 %}
|
||||
Google | Firebase Cloud Messaging Server Key | firebase_cloud_messaging_server_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Google | Google API Key | google_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Google | Google API Key | google_api_key
|
||||
Google | Google Cloud Private Key ID | google_cloud_private_key_id{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
Google | Google Cloud Storage Access Key Secret | google_cloud_storage_access_key_secret{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
Google | Google Cloud Storage Service Account Access Key ID | google_cloud_storage_service_account_access_key_id{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.2 %}
|
||||
Google | Google Cloud Storage Access Key Secret | google_cloud_storage_access_key_secret
|
||||
Google | Google Cloud Storage Service Account Access Key ID | google_cloud_storage_service_account_access_key_id
|
||||
Google | Google Cloud Storage User Access Key ID | google_cloud_storage_user_access_key_id{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Grafana | Grafana API Key | grafana_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Hashicorp Terraform | Terraform Cloud / Enterprise API Token | terraform_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Hashicorp Terraform | Terraform Cloud / Enterprise API Token | terraform_api_token
|
||||
Hubspot | Hubspot API Key | hubspot_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Intercom | Intercom Access Token | intercom_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Ionic | Ionic Personal Access Token | ionic_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Intercom | Intercom Access Token | intercom_access_token
|
||||
Ionic | Ionic Personal Access Token | ionic_personal_access_token
|
||||
Ionic | Ionic Refresh Token | ionic_refresh_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
JFrog | JFrog Platform Access Token | jfrog_platform_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.2 %}
|
||||
JFrog | JFrog Platform Access Token | jfrog_platform_access_token
|
||||
JFrog | JFrog Platform API Key | jfrog_platform_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Linear | Linear API Key | linear_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Linear | Linear OAuth Access Token | linear_oauth_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Lob | Lob Live API Key | lob_live_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Linear | Linear API Key | linear_api_key
|
||||
Linear | Linear OAuth Access Token | linear_oauth_access_token
|
||||
Lob | Lob Live API Key | lob_live_api_key
|
||||
Lob | Lob Test API Key | lob_test_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Mailchimp | Mailchimp API Key | mailchimp_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Mailchimp | Mailchimp API Key | mailchimp_api_key
|
||||
Mailgun | Mailgun API Key | mailgun_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
MessageBird | MessageBird API Key | messagebird_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
New Relic | New Relic Personal API Key | new_relic_personal_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
New Relic | New Relic REST API Key | new_relic_rest_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
New Relic | New Relic Insights Query Key | new_relic_insights_query_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.2 %}
|
||||
New Relic | New Relic Personal API Key | new_relic_personal_api_key
|
||||
New Relic | New Relic REST API Key | new_relic_rest_api_key
|
||||
New Relic | New Relic Insights Query Key | new_relic_insights_query_key
|
||||
New Relic | New Relic License Key | new_relic_license_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
npm | npm Access Token | npm_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
npm | npm Access Token | npm_access_token
|
||||
NuGet | NuGet API Key | nuget_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Onfido | Onfido Live API Token | onfido_live_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Onfido | Onfido Sandbox API Token | onfido_sandbox_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Onfido | Onfido Live API Token | onfido_live_api_token
|
||||
Onfido | Onfido Sandbox API Token | onfido_sandbox_api_token
|
||||
OpenAI | OpenAI API Key | openai_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Palantir | Palantir JSON Web Token | palantir_jwt{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
PlanetScale | PlanetScale Database Password | planetscale_database_password{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
PlanetScale | PlanetScale OAuth Token | planetscale_oauth_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
PlanetScale | PlanetScale Service Token | planetscale_service_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
Plivo | Plivo Auth ID | plivo_auth_id{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.2 %}
|
||||
PlanetScale | PlanetScale Database Password | planetscale_database_password
|
||||
PlanetScale | PlanetScale OAuth Token | planetscale_oauth_token
|
||||
PlanetScale | PlanetScale Service Token | planetscale_service_token
|
||||
Plivo | Plivo Auth ID | plivo_auth_id
|
||||
Plivo | Plivo Auth Token | plivo_auth_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Postman | Postman API Key | postman_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Proctorio | Proctorio Consumer Key | proctorio_consumer_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Proctorio | Proctorio Linkage Key | proctorio_linkage_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Proctorio | Proctorio Registration Key | proctorio_registration_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Proctorio | Proctorio Secret Key | proctorio_secret_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Postman | Postman API Key | postman_api_key
|
||||
Proctorio | Proctorio Consumer Key | proctorio_consumer_key
|
||||
Proctorio | Proctorio Linkage Key | proctorio_linkage_key
|
||||
Proctorio | Proctorio Registration Key | proctorio_registration_key
|
||||
Proctorio | Proctorio Secret Key | proctorio_secret_key
|
||||
Pulumi | Pulumi Access Token | pulumi_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
PyPI | PyPI API Token | pypi_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
PyPI | PyPI API Token | pypi_api_token
|
||||
RubyGems | RubyGems API Key | rubygems_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Samsara | Samsara API Token | samsara_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Samsara | Samsara API Token | samsara_api_token
|
||||
Samsara | Samsara OAuth Access Token | samsara_oauth_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
SendGrid | SendGrid API Key | sendgrid_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
Sendinblue | Sendinblue API Key | sendinblue_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.2 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.2 %}
|
||||
Sendinblue | Sendinblue API Key | sendinblue_api_key
|
||||
Sendinblue | Sendinblue SMTP Key | sendinblue_smtp_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Shippo | Shippo Live API Token | shippo_live_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Shippo | Shippo Live API Token | shippo_live_api_token
|
||||
Shippo | Shippo Test API Token | shippo_test_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Shopify | Shopify App Shared Secret | shopify_app_shared_secret{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Shopify | Shopify Access Token | shopify_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Shopify | Shopify Private App Password | shopify_private_app_password{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Slack | Slack API Token | slack_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Slack | Slack Incoming Webhook URL | slack_incoming_webhook_url{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Slack | Slack Workflow Webhook URL | slack_workflow_webhook_url{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
SSLMate | SSLMate API Key | sslmate_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
SSLMate | SSLMate Cluster Secret | sslmate_cluster_secret{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Shopify | Shopify App Shared Secret | shopify_app_shared_secret
|
||||
Shopify | Shopify Access Token | shopify_access_token
|
||||
Shopify | Shopify Custom App Access Token | shopify_custom_app_access_token
|
||||
Shopify | Shopify Private App Password | shopify_private_app_password
|
||||
Slack | Slack API Token | slack_api_token
|
||||
Slack | Slack Incoming Webhook URL | slack_incoming_webhook_url
|
||||
Slack | Slack Workflow Webhook URL | slack_workflow_webhook_url
|
||||
SSLMate | SSLMate API Key | sslmate_api_key
|
||||
SSLMate | SSLMate Cluster Secret | sslmate_cluster_secret
|
||||
Stripe | Stripe API Key | stripe_api_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
Stripe | Stripe Live API Secret Key | stripe_live_secret_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
Stripe | Stripe Test API Secret Key | stripe_test_secret_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
Stripe | Stripe Live API Restricted Key | stripe_live_restricted_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 3.0 or ghae %}
|
||||
Stripe | Stripe Live API Secret Key | stripe_live_secret_key
|
||||
Stripe | Stripe Test API Secret Key | stripe_test_secret_key
|
||||
Stripe | Stripe Live API Restricted Key | stripe_live_restricted_key
|
||||
Stripe | Stripe Test API Restricted Key | stripe_test_restricted_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Stripe | Stripe Webhook Signing Secret | stripe_webhook_signing_secret{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Tableau | Tableau Personal Access Token | tableau_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Stripe | Stripe Webhook Signing Secret | stripe_webhook_signing_secret
|
||||
Tableau | Tableau Personal Access Token | tableau_personal_access_token
|
||||
Telegram | Telegram Bot Token | telegram_bot_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Tencent Cloud | Tencent Cloud Secret ID | tencent_cloud_secret_id{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Twilio | Twilio Account String Identifier | twilio_account_sid{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae %}
|
||||
Tencent Cloud | Tencent Cloud Secret ID | tencent_cloud_secret_id
|
||||
Twilio | Twilio Account String Identifier | twilio_account_sid
|
||||
Twilio | Twilio API Key | twilio_api_key{% endif %}
|
||||
|
||||
@@ -24713,12 +24713,22 @@
|
||||
{
|
||||
"name": "secret_type",
|
||||
"in": "query",
|
||||
"description": "A comma separated list of secret types to return. By default all secret types are returned.",
|
||||
"description": "A comma-separated list of secret types to return. By default all secret types are returned.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>A comma separated list of secret types to return. By default all secret types are returned.</p>"
|
||||
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.</p>"
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"in": "query",
|
||||
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are <code>false_positive</code>, <code>wont_fix</code>, <code>revoked</code>, <code>pattern_edited</code>, <code>pattern_deleted</code> or <code>used_in_tests</code>.</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
@@ -46759,6 +46769,100 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest",
|
||||
"serverUrl": "https://api.github.com",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "check_run_id",
|
||||
"description": "check_run_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>check_run_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/rerequest",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/rerequest</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">check_run_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Rerequest a check run",
|
||||
"description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
|
||||
"tags": [
|
||||
"checks"
|
||||
],
|
||||
"operationId": "checks/rerequest-run",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/checks#rerequest-a-check-run"
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [],
|
||||
"category": "checks",
|
||||
"subcategory": "runs"
|
||||
},
|
||||
"slug": "rerequest-a-check-run",
|
||||
"category": "checks",
|
||||
"categoryLabel": "Checks",
|
||||
"subcategory": "runs",
|
||||
"subcategoryLabel": "Runs",
|
||||
"notes": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "Response"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "Resource not found"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "Validation error if the check run is not rerequestable"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> event with the action <code>rerequested</code>. When a check run is <code>rerequested</code>, its <code>status</code> is reset to <code>queued</code> and the <code>conclusion</code> is cleared.</p>\n<p>To rerequest a check run, your GitHub App must have the <code>checks:read</code> permission on a private repository or pull access to a public repository.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/check-suites",
|
||||
@@ -67328,13 +67432,13 @@
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'</code></pre>"
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">source</span>: {\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>\n },\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'switcheroo'</span>\n ]\n }\n})\n</code></pre>"
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">source</span>: {\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>\n }\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Create a GitHub Pages site",
|
||||
@@ -67441,14 +67545,6 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
},
|
||||
@@ -67472,11 +67568,6 @@
|
||||
"httpStatusMessage": "Conflict",
|
||||
"description": "Conflict"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -67839,13 +67930,13 @@
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages</code></pre>"
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'switcheroo'</span>\n ]\n }\n})\n</code></pre>"
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a GitHub Pages site",
|
||||
@@ -67861,14 +67952,6 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
},
|
||||
@@ -67889,11 +67972,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "Resource not found"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -73435,6 +73513,16 @@
|
||||
"rawType": "string",
|
||||
"rawDescription": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
"generate_release_notes": {
|
||||
"type": "boolean",
|
||||
"description": "<p>Whether to automatically generate the name and body for this release. If <code>name</code> is specified, the specified name will be used; otherwise, a name will be automatically generated. If <code>body</code> is specified, the body will be pre-pended to the automatically generated notes.</p>",
|
||||
"default": false,
|
||||
"name": "generate_release_notes",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -73447,7 +73535,8 @@
|
||||
"name": "v1.0.0",
|
||||
"body": "Description of the release",
|
||||
"draft": false,
|
||||
"prerelease": false
|
||||
"prerelease": false,
|
||||
"generate_release_notes": false
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -73533,6 +73622,16 @@
|
||||
"rawType": "string",
|
||||
"rawDescription": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Whether to automatically generate the name and body for this release. If <code>name</code> is specified, the specified name will be used; otherwise, a name will be automatically generated. If <code>body</code> is specified, the body will be pre-pended to the automatically generated notes.</p>",
|
||||
"default": false,
|
||||
"name": "generate_release_notes",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
],
|
||||
"responses": [
|
||||
@@ -75002,12 +75101,22 @@
|
||||
{
|
||||
"name": "secret_type",
|
||||
"in": "query",
|
||||
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>A comma separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
|
||||
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"in": "query",
|
||||
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are <code>false_positive</code>, <code>wont_fix</code>, <code>revoked</code>, <code>pattern_edited</code>, <code>pattern_deleted</code> or <code>used_in_tests</code>.</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
@@ -75163,6 +75272,11 @@
|
||||
"description": "Response",
|
||||
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"number\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">42</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"created_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2020-11-06T18:18:30Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"html_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/owner/private-repo/security/secret-scanning/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"state\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"open\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolution\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_by\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret_type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"mailchimp_api_key\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "304",
|
||||
"httpStatusMessage": "Not Modified",
|
||||
"description": "Not modified"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
@@ -87758,7 +87872,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-blocked-by-authenticated",
|
||||
"operationId": "users/list-blocked-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user"
|
||||
@@ -88079,7 +88193,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/set-primary-email-visibility-for-authenticated",
|
||||
"operationId": "users/set-primary-email-visibility-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user"
|
||||
@@ -88219,7 +88333,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-emails-for-authenticated",
|
||||
"operationId": "users/list-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
||||
@@ -88290,7 +88404,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/add-email-for-authenticated",
|
||||
"operationId": "users/add-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
||||
@@ -88433,7 +88547,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-email-for-authenticated",
|
||||
"operationId": "users/delete-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
||||
@@ -88682,7 +88796,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -89009,7 +89123,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -89077,7 +89191,7 @@
|
||||
],
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -89202,7 +89316,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -89284,7 +89398,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -89575,7 +89689,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -89660,7 +89774,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -90157,7 +90271,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -90225,7 +90339,7 @@
|
||||
],
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -90372,7 +90486,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -90454,7 +90568,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -91689,7 +91803,7 @@
|
||||
"tags": [
|
||||
"migrations"
|
||||
],
|
||||
"operationId": "migrations/list-repos-for-user",
|
||||
"operationId": "migrations/list-repos-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration"
|
||||
@@ -92757,7 +92871,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-emails-for-authenticated",
|
||||
"operationId": "users/list-public-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
||||
@@ -93596,7 +93710,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -93677,7 +93791,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -8897,7 +8897,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runner groups for an enterprise",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -8920,7 +8920,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -8959,7 +8959,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a self-hosted runner group for an enterprise",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -9057,7 +9057,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"contentType": "application/json",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. Name of the runner group.</p>",
|
||||
@@ -9156,7 +9156,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Get a self-hosted runner group for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -9179,7 +9179,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -9228,7 +9228,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Update a self-hosted runner group for an enterprise",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -9289,7 +9289,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"contentType": "application/json",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p>Name of the runner group.</p>",
|
||||
@@ -9363,7 +9363,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Delete a self-hosted runner group from an enterprise",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -9393,7 +9393,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -9454,7 +9454,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -9477,7 +9477,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -9526,7 +9526,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -9590,7 +9590,7 @@
|
||||
"description": "Response"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. List of organization IDs that can access the runner group.</p>",
|
||||
@@ -9656,7 +9656,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -9686,7 +9686,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
@@ -9737,7 +9737,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -9767,7 +9767,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -9828,7 +9828,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runners in a group for an enterprise",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -9851,7 +9851,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -9900,7 +9900,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Set self-hosted runners in a group for an enterprise",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -9964,7 +9964,7 @@
|
||||
"description": "Response"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. List of runner IDs to add to the runner group.</p>",
|
||||
@@ -10030,7 +10030,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Add a self-hosted runner to a group for an enterprise",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -10060,7 +10060,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code>\nscope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code>\nscope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
@@ -10111,7 +10111,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -10141,7 +10141,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -10192,7 +10192,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runners for an enterprise",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -10215,7 +10215,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -10254,7 +10254,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List runner applications for an enterprise",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -10277,7 +10277,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -10316,7 +10316,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a registration token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -10339,7 +10339,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -10378,7 +10378,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a remove token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -10401,7 +10401,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -10450,7 +10450,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Get a self-hosted runner for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -10473,7 +10473,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -10522,7 +10522,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Delete a self-hosted runner from an enterprise",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -10552,7 +10552,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -58410,6 +58410,8 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
@@ -58417,9 +58419,7 @@
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
},
|
||||
"slug": "create-a-github-enterprise-server-pages-site",
|
||||
"category": "repos",
|
||||
@@ -58441,11 +58441,6 @@
|
||||
"httpStatusMessage": "Conflict",
|
||||
"description": "Conflict"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -58830,6 +58825,8 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
@@ -58837,9 +58834,7 @@
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@2.22/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
},
|
||||
"slug": "delete-a-github-enterprise-server-pages-site",
|
||||
"category": "repos",
|
||||
@@ -58858,11 +58853,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "Resource not found"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -73488,7 +73478,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-emails-for-authenticated",
|
||||
"operationId": "users/list-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
||||
@@ -73559,7 +73549,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/add-email-for-authenticated",
|
||||
"operationId": "users/add-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
||||
@@ -73702,7 +73692,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-email-for-authenticated",
|
||||
"operationId": "users/delete-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
||||
@@ -73951,7 +73941,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -74278,7 +74268,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -74346,7 +74336,7 @@
|
||||
],
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -74471,7 +74461,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -74553,7 +74543,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -74844,7 +74834,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -74929,7 +74919,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -75194,7 +75184,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -75262,7 +75252,7 @@
|
||||
],
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -75409,7 +75399,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -75491,7 +75481,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -76103,7 +76093,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-emails-for-authenticated",
|
||||
"operationId": "users/list-public-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
||||
@@ -76925,7 +76915,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -77006,7 +76996,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -11921,7 +11921,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runner groups for an enterprise",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -11944,7 +11944,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -11983,7 +11983,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a self-hosted runner group for an enterprise",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12081,7 +12081,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"contentType": "application/json",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. Name of the runner group.</p>",
|
||||
@@ -12180,7 +12180,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Get a self-hosted runner group for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12203,7 +12203,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -12252,7 +12252,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Update a self-hosted runner group for an enterprise",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12313,7 +12313,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"contentType": "application/json",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p>Name of the runner group.</p>",
|
||||
@@ -12387,7 +12387,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Delete a self-hosted runner group from an enterprise",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12417,7 +12417,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -12478,7 +12478,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12501,7 +12501,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -12550,7 +12550,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12614,7 +12614,7 @@
|
||||
"description": "Response"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. List of organization IDs that can access the runner group.</p>",
|
||||
@@ -12680,7 +12680,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12710,7 +12710,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
@@ -12761,7 +12761,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12791,7 +12791,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -12852,7 +12852,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runners in a group for an enterprise",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12875,7 +12875,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -12924,7 +12924,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Set self-hosted runners in a group for an enterprise",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12988,7 +12988,7 @@
|
||||
"description": "Response"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. List of runner IDs to add to the runner group.</p>",
|
||||
@@ -13054,7 +13054,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Add a self-hosted runner to a group for an enterprise",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13084,7 +13084,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code>\nscope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code>\nscope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
@@ -13135,7 +13135,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13165,7 +13165,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -13216,7 +13216,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runners for an enterprise",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13239,7 +13239,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -13278,7 +13278,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List runner applications for an enterprise",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13301,7 +13301,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -13340,7 +13340,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a registration token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13363,7 +13363,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -13402,7 +13402,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a remove token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13425,7 +13425,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -13474,7 +13474,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Get a self-hosted runner for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13497,7 +13497,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -13546,7 +13546,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Delete a self-hosted runner from an enterprise",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13576,7 +13576,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -63213,6 +63213,8 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
@@ -63220,9 +63222,7 @@
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
},
|
||||
"slug": "create-a-github-enterprise-server-pages-site",
|
||||
"category": "repos",
|
||||
@@ -63244,11 +63244,6 @@
|
||||
"httpStatusMessage": "Conflict",
|
||||
"description": "Conflict"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -63633,6 +63628,8 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
@@ -63640,9 +63637,7 @@
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
},
|
||||
"slug": "delete-a-github-enterprise-server-pages-site",
|
||||
"category": "repos",
|
||||
@@ -63661,11 +63656,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "Resource not found"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -78291,7 +78281,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-emails-for-authenticated",
|
||||
"operationId": "users/list-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
||||
@@ -78362,7 +78352,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/add-email-for-authenticated",
|
||||
"operationId": "users/add-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
||||
@@ -78505,7 +78495,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-email-for-authenticated",
|
||||
"operationId": "users/delete-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
||||
@@ -78754,7 +78744,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -79081,7 +79071,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -79149,7 +79139,7 @@
|
||||
],
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -79274,7 +79264,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -79356,7 +79346,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -79647,7 +79637,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -79732,7 +79722,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -79997,7 +79987,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -80065,7 +80055,7 @@
|
||||
],
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -80212,7 +80202,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -80294,7 +80284,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -80906,7 +80896,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-emails-for-authenticated",
|
||||
"operationId": "users/list-public-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
||||
@@ -81728,7 +81718,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -81809,7 +81799,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -11921,7 +11921,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runner groups for an enterprise",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -11944,7 +11944,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -11983,7 +11983,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a self-hosted runner group for an enterprise",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12081,7 +12081,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"contentType": "application/json",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. Name of the runner group.</p>",
|
||||
@@ -12180,7 +12180,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Get a self-hosted runner group for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12203,7 +12203,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -12252,7 +12252,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Update a self-hosted runner group for an enterprise",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12313,7 +12313,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"contentType": "application/json",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p>Name of the runner group.</p>",
|
||||
@@ -12387,7 +12387,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Delete a self-hosted runner group from an enterprise",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12417,7 +12417,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -12478,7 +12478,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12501,7 +12501,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -12550,7 +12550,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12614,7 +12614,7 @@
|
||||
"description": "Response"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. List of organization IDs that can access the runner group.</p>",
|
||||
@@ -12680,7 +12680,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12710,7 +12710,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
@@ -12761,7 +12761,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12791,7 +12791,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -12852,7 +12852,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runners in a group for an enterprise",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12875,7 +12875,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -12924,7 +12924,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Set self-hosted runners in a group for an enterprise",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12988,7 +12988,7 @@
|
||||
"description": "Response"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. List of runner IDs to add to the runner group.</p>",
|
||||
@@ -13054,7 +13054,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Add a self-hosted runner to a group for an enterprise",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13084,7 +13084,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code>\nscope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code>\nscope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
@@ -13135,7 +13135,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13165,7 +13165,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -13216,7 +13216,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runners for an enterprise",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13239,7 +13239,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -13278,7 +13278,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List runner applications for an enterprise",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13301,7 +13301,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -13340,7 +13340,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a registration token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13363,7 +13363,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -13402,7 +13402,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a remove token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13425,7 +13425,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -13474,7 +13474,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Get a self-hosted runner for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13497,7 +13497,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -13546,7 +13546,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Delete a self-hosted runner from an enterprise",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13576,7 +13576,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -63903,6 +63903,8 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
@@ -63910,9 +63912,7 @@
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
},
|
||||
"slug": "create-a-github-enterprise-server-pages-site",
|
||||
"category": "repos",
|
||||
@@ -63934,11 +63934,6 @@
|
||||
"httpStatusMessage": "Conflict",
|
||||
"description": "Conflict"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -64323,6 +64318,8 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
@@ -64330,9 +64327,7 @@
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
},
|
||||
"slug": "delete-a-github-enterprise-server-pages-site",
|
||||
"category": "repos",
|
||||
@@ -64351,11 +64346,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "Resource not found"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -71491,12 +71481,22 @@
|
||||
{
|
||||
"name": "secret_type",
|
||||
"in": "query",
|
||||
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>A comma separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
|
||||
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"in": "query",
|
||||
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are <code>false_positive</code>, <code>wont_fix</code>, <code>revoked</code>, <code>pattern_edited</code>, <code>pattern_deleted</code> or <code>used_in_tests</code>.</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
@@ -71652,6 +71652,11 @@
|
||||
"description": "Response",
|
||||
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"number\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">42</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"created_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2020-11-06T18:18:30Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"html_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/owner/private-repo/security/secret-scanning/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"state\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"open\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolution\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_by\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret_type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"mailchimp_api_key\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "304",
|
||||
"httpStatusMessage": "Not Modified",
|
||||
"description": "Not modified"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
@@ -79194,7 +79199,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-emails-for-authenticated",
|
||||
"operationId": "users/list-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
||||
@@ -79265,7 +79270,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/add-email-for-authenticated",
|
||||
"operationId": "users/add-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
||||
@@ -79408,7 +79413,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-email-for-authenticated",
|
||||
"operationId": "users/delete-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
||||
@@ -79657,7 +79662,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -79984,7 +79989,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -80052,7 +80057,7 @@
|
||||
],
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -80177,7 +80182,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -80259,7 +80264,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -80550,7 +80555,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -80635,7 +80640,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -80900,7 +80905,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -80968,7 +80973,7 @@
|
||||
],
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -81115,7 +81120,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -81197,7 +81202,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -81809,7 +81814,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-emails-for-authenticated",
|
||||
"operationId": "users/list-public-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
||||
@@ -82631,7 +82636,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -82712,7 +82717,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -12144,7 +12144,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runner groups for an enterprise",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12167,7 +12167,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -12206,7 +12206,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a self-hosted runner group for an enterprise",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12304,7 +12304,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"contentType": "application/json",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. Name of the runner group.</p>",
|
||||
@@ -12403,7 +12403,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Get a self-hosted runner group for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12426,7 +12426,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -12475,7 +12475,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Update a self-hosted runner group for an enterprise",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12536,7 +12536,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"contentType": "application/json",
|
||||
"notes": [],
|
||||
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p>Name of the runner group.</p>",
|
||||
@@ -12610,7 +12610,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Delete a self-hosted runner group from an enterprise",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12640,7 +12640,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -12701,7 +12701,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12724,7 +12724,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -12773,7 +12773,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12837,7 +12837,7 @@
|
||||
"description": "Response"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. List of organization IDs that can access the runner group.</p>",
|
||||
@@ -12903,7 +12903,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -12933,7 +12933,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
@@ -12984,7 +12984,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13014,7 +13014,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -13075,7 +13075,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runners in a group for an enterprise",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13098,7 +13098,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -13147,7 +13147,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Set self-hosted runners in a group for an enterprise",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13211,7 +13211,7 @@
|
||||
"description": "Response"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"bodyParameters": [
|
||||
{
|
||||
"description": "<p><strong>Required</strong>. List of runner IDs to add to the runner group.</p>",
|
||||
@@ -13277,7 +13277,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Add a self-hosted runner to a group for an enterprise",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13307,7 +13307,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code>\nscope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code>\nscope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "delete",
|
||||
@@ -13358,7 +13358,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13388,7 +13388,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -13439,7 +13439,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List self-hosted runners for an enterprise",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13462,7 +13462,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -13501,7 +13501,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "List runner applications for an enterprise",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13524,7 +13524,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -13563,7 +13563,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a registration token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13586,7 +13586,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -13625,7 +13625,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Create a remove token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13648,7 +13648,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -13697,7 +13697,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Get a self-hosted runner for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13720,7 +13720,7 @@
|
||||
"subcategoryLabel": "Actions",
|
||||
"notes": [],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
|
||||
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -13769,7 +13769,7 @@
|
||||
}
|
||||
],
|
||||
"summary": "Delete a self-hosted runner from an enterprise",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -13799,7 +13799,7 @@
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
|
||||
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
@@ -66109,6 +66109,8 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
@@ -66116,9 +66118,7 @@
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
},
|
||||
"slug": "create-a-github-enterprise-server-pages-site",
|
||||
"category": "repos",
|
||||
@@ -66140,11 +66140,6 @@
|
||||
"httpStatusMessage": "Conflict",
|
||||
"description": "Conflict"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -66529,6 +66524,8 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
@@ -66536,9 +66533,7 @@
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
},
|
||||
"slug": "delete-a-github-enterprise-server-pages-site",
|
||||
"category": "repos",
|
||||
@@ -66557,11 +66552,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "Resource not found"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -73846,12 +73836,22 @@
|
||||
{
|
||||
"name": "secret_type",
|
||||
"in": "query",
|
||||
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>A comma separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
|
||||
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned. See \"<a href=\"https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\" for a complete list of secret types (API slug).</p>"
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"in": "query",
|
||||
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are <code>false_positive</code>, <code>wont_fix</code>, <code>revoked</code>, <code>pattern_edited</code>, <code>pattern_deleted</code> or <code>used_in_tests</code>.</p>"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
@@ -74007,6 +74007,11 @@
|
||||
"description": "Response",
|
||||
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"number\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">42</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"created_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2020-11-06T18:18:30Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"html_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/owner/private-repo/security/secret-scanning/42\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"state\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"open\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolution\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"resolved_by\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">null</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret_type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"mailchimp_api_key\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"secret\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "304",
|
||||
"httpStatusMessage": "Not Modified",
|
||||
"description": "Not modified"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
@@ -82017,7 +82022,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-emails-for-authenticated",
|
||||
"operationId": "users/list-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
||||
@@ -82088,7 +82093,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/add-email-for-authenticated",
|
||||
"operationId": "users/add-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
||||
@@ -82231,7 +82236,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-email-for-authenticated",
|
||||
"operationId": "users/delete-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
||||
@@ -82480,7 +82485,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -82807,7 +82812,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -82875,7 +82880,7 @@
|
||||
],
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -83000,7 +83005,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -83082,7 +83087,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -83373,7 +83378,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -83458,7 +83463,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -83723,7 +83728,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -83791,7 +83796,7 @@
|
||||
],
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -83938,7 +83943,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -84020,7 +84025,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -84632,7 +84637,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-emails-for-authenticated",
|
||||
"operationId": "users/list-public-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
||||
@@ -85471,7 +85476,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -85552,7 +85557,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -38546,6 +38546,100 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest",
|
||||
"serverUrl": "https://{hostname}/api/v3",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "check_run_id",
|
||||
"description": "check_run_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
},
|
||||
"descriptionHTML": "<p>check_run_id parameter</p>"
|
||||
}
|
||||
],
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/rerequest",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/rerequest</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">check_run_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Rerequest a check run",
|
||||
"description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
|
||||
"tags": [
|
||||
"checks"
|
||||
],
|
||||
"operationId": "checks/rerequest-run",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-run"
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [],
|
||||
"category": "checks",
|
||||
"subcategory": "runs"
|
||||
},
|
||||
"slug": "rerequest-a-check-run",
|
||||
"category": "checks",
|
||||
"categoryLabel": "Checks",
|
||||
"subcategory": "runs",
|
||||
"subcategoryLabel": "Runs",
|
||||
"notes": [],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"httpStatusMessage": "Created",
|
||||
"description": "Response"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"httpStatusMessage": "Forbidden",
|
||||
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "Resource not found"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
"description": "Validation error if the check run is not rerequestable"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run\"><code>check_run</code> webhook</a> event with the action <code>rerequested</code>. When a check run is <code>rerequested</code>, its <code>status</code> is reset to <code>queued</code> and the <code>conclusion</code> is cleared.</p>\n<p>To rerequest a check run, your GitHub App must have the <code>checks:read</code> permission on a private repository or pull access to a public repository.</p>"
|
||||
},
|
||||
{
|
||||
"verb": "post",
|
||||
"requestPath": "/repos/{owner}/{repo}/check-suites",
|
||||
@@ -56940,13 +57034,13 @@
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'</code></pre>"
|
||||
"source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">source</span>: {\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>\n },\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'switcheroo'</span>\n ]\n }\n})\n</code></pre>"
|
||||
"source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'POST /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">source</span>: {\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>\n }\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Create a GitHub AE Pages site",
|
||||
@@ -57053,14 +57147,6 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
},
|
||||
@@ -57084,11 +57170,6 @@
|
||||
"httpStatusMessage": "Conflict",
|
||||
"description": "Conflict"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -57451,13 +57532,13 @@
|
||||
"x-codeSamples": [
|
||||
{
|
||||
"lang": "Shell",
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages</code></pre>"
|
||||
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages",
|
||||
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages</code></pre>"
|
||||
},
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'switcheroo'</span>\n ]\n }\n})\n</code></pre>"
|
||||
"source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
|
||||
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>\n})\n</code></pre>"
|
||||
}
|
||||
],
|
||||
"summary": "Delete a GitHub AE Pages site",
|
||||
@@ -57473,14 +57554,6 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
|
||||
"html": "<p>Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the <a href=\"https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/\">blog post</a> preview for more details. To access the new endpoints during the preview period, you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.switcheroo-preview+json</code></pre>"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
},
|
||||
@@ -57501,11 +57574,6 @@
|
||||
"httpStatusMessage": "Not Found",
|
||||
"description": "Resource not found"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "415",
|
||||
"httpStatusMessage": "Unsupported Media Type",
|
||||
"description": "Preview header missing"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"httpStatusMessage": "Unprocessable Entity",
|
||||
@@ -71924,7 +71992,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -72251,7 +72319,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -72319,7 +72387,7 @@
|
||||
],
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -72444,7 +72512,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -72526,7 +72594,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -72817,7 +72885,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -72902,7 +72970,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -73154,7 +73222,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -73222,7 +73290,7 @@
|
||||
],
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -73369,7 +73437,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -73451,7 +73519,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -74803,7 +74871,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -74884,7 +74952,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -93305,7 +93305,16 @@
|
||||
{
|
||||
"name": "secret_type",
|
||||
"in": "query",
|
||||
"description": "A comma separated list of secret types to return. By default all secret types are returned.",
|
||||
"description": "A comma-separated list of secret types to return. By default all secret types are returned.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"in": "query",
|
||||
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
@@ -166839,6 +166848,149 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": {
|
||||
"post": {
|
||||
"summary": "Rerequest a check run",
|
||||
"description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
|
||||
"tags": [
|
||||
"checks"
|
||||
],
|
||||
"operationId": "checks/rerequest-run",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/checks#rerequest-a-check-run"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "check_run_id",
|
||||
"description": "check_run_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
},
|
||||
"additionalProperties": false
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"title": "Basic Error",
|
||||
"description": "Basic Error",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation error if the check run is not rerequestable",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"title": "Basic Error",
|
||||
"description": "Basic Error",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Resource not found",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"title": "Basic Error",
|
||||
"description": "Basic Error",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
|
||||
],
|
||||
"category": "checks",
|
||||
"subcategory": "runs"
|
||||
}
|
||||
}
|
||||
},
|
||||
"/repos/{owner}/{repo}/check-suites": {
|
||||
"post": {
|
||||
"summary": "Create a check suite",
|
||||
@@ -289620,28 +289772,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"409": {
|
||||
"description": "Conflict",
|
||||
"content": {
|
||||
@@ -289672,13 +289802,6 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
}
|
||||
@@ -290047,28 +290170,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Resource not found",
|
||||
"content": {
|
||||
@@ -290099,13 +290200,6 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
}
|
||||
@@ -326539,6 +326633,11 @@
|
||||
"discussion_category_name": {
|
||||
"type": "string",
|
||||
"description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""
|
||||
},
|
||||
"generate_release_notes": {
|
||||
"type": "boolean",
|
||||
"description": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.",
|
||||
"default": false
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -326551,7 +326650,8 @@
|
||||
"name": "v1.0.0",
|
||||
"body": "Description of the release",
|
||||
"draft": false,
|
||||
"prerelease": false
|
||||
"prerelease": false,
|
||||
"generate_release_notes": false
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -331898,7 +331998,16 @@
|
||||
{
|
||||
"name": "secret_type",
|
||||
"in": "query",
|
||||
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"in": "query",
|
||||
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
@@ -332467,6 +332576,9 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"304": {
|
||||
"description": "Not modified"
|
||||
},
|
||||
"404": {
|
||||
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
|
||||
},
|
||||
@@ -371171,7 +371283,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-blocked-by-authenticated",
|
||||
"operationId": "users/list-blocked-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user"
|
||||
@@ -371879,7 +371991,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/set-primary-email-visibility-for-authenticated",
|
||||
"operationId": "users/set-primary-email-visibility-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user"
|
||||
@@ -372133,7 +372245,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-emails-for-authenticated",
|
||||
"operationId": "users/list-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
||||
@@ -372318,7 +372430,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/add-email-for-authenticated",
|
||||
"operationId": "users/add-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
||||
@@ -372606,7 +372718,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-email-for-authenticated",
|
||||
"operationId": "users/delete-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
||||
@@ -373095,7 +373207,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -373711,7 +373823,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -374054,7 +374166,7 @@
|
||||
"post": {
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -374463,7 +374575,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -374787,7 +374899,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -377299,7 +377411,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -377399,7 +377511,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -380539,7 +380651,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -380740,7 +380852,7 @@
|
||||
"post": {
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -381004,7 +381116,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -381177,7 +381289,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -388520,7 +388632,7 @@
|
||||
"tags": [
|
||||
"migrations"
|
||||
],
|
||||
"operationId": "migrations/list-repos-for-user",
|
||||
"operationId": "migrations/list-repos-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration"
|
||||
@@ -396214,7 +396326,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-emails-for-authenticated",
|
||||
"operationId": "users/list-public-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
||||
@@ -401721,7 +401833,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -401839,7 +401951,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -22174,7 +22174,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runner groups for an enterprise",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -22316,7 +22316,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Create a self-hosted runner group for an enterprise",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -22461,7 +22461,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
|
||||
"get": {
|
||||
"summary": "Get a self-hosted runner group for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -22558,7 +22558,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Update a self-hosted runner group for an enterprise",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -22683,7 +22683,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Delete a self-hosted runner group from an enterprise",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -22731,7 +22731,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
|
||||
"get": {
|
||||
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -22910,7 +22910,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -22987,7 +22987,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
|
||||
"put": {
|
||||
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -23042,7 +23042,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -23099,7 +23099,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runners in a group for an enterprise",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -23233,7 +23233,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set self-hosted runners in a group for an enterprise",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -23310,7 +23310,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
|
||||
"put": {
|
||||
"summary": "Add a self-hosted runner to a group for an enterprise",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -23365,7 +23365,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -23422,7 +23422,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runners for an enterprise",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -23545,7 +23545,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/downloads": {
|
||||
"get": {
|
||||
"summary": "List runner applications for an enterprise",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -23659,7 +23659,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/registration-token": {
|
||||
"post": {
|
||||
"summary": "Create a registration token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -24846,7 +24846,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/remove-token": {
|
||||
"post": {
|
||||
"summary": "Create a remove token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26033,7 +26033,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
|
||||
"get": {
|
||||
"summary": "Get a self-hosted runner for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26114,7 +26114,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Delete a self-hosted runner from an enterprise",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -254238,28 +254238,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"409": {
|
||||
"description": "Conflict",
|
||||
"content": {
|
||||
@@ -254290,15 +254268,15 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
@@ -254665,28 +254643,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Resource not found",
|
||||
"content": {
|
||||
@@ -254717,15 +254673,15 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -326901,7 +326857,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-emails-for-authenticated",
|
||||
"operationId": "users/list-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
||||
@@ -327086,7 +327042,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/add-email-for-authenticated",
|
||||
"operationId": "users/add-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
||||
@@ -327374,7 +327330,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-email-for-authenticated",
|
||||
"operationId": "users/delete-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
||||
@@ -327863,7 +327819,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -328479,7 +328435,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -328822,7 +328778,7 @@
|
||||
"post": {
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -329231,7 +329187,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -329555,7 +329511,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -331802,7 +331758,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -331902,7 +331858,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -334754,7 +334710,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -334955,7 +334911,7 @@
|
||||
"post": {
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -335219,7 +335175,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -335392,7 +335348,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -337544,7 +337500,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-emails-for-authenticated",
|
||||
"operationId": "users/list-public-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
||||
@@ -343017,7 +342973,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -343135,7 +343091,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -24888,7 +24888,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runner groups for an enterprise",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25030,7 +25030,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Create a self-hosted runner group for an enterprise",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25175,7 +25175,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
|
||||
"get": {
|
||||
"summary": "Get a self-hosted runner group for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25272,7 +25272,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Update a self-hosted runner group for an enterprise",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25397,7 +25397,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Delete a self-hosted runner group from an enterprise",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25445,7 +25445,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
|
||||
"get": {
|
||||
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25624,7 +25624,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25701,7 +25701,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
|
||||
"put": {
|
||||
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25756,7 +25756,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25813,7 +25813,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runners in a group for an enterprise",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26028,7 +26028,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set self-hosted runners in a group for an enterprise",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26105,7 +26105,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
|
||||
"put": {
|
||||
"summary": "Add a self-hosted runner to a group for an enterprise",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26160,7 +26160,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26217,7 +26217,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runners for an enterprise",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26421,7 +26421,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/downloads": {
|
||||
"get": {
|
||||
"summary": "List runner applications for an enterprise",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26535,7 +26535,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/registration-token": {
|
||||
"post": {
|
||||
"summary": "Create a registration token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -27722,7 +27722,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/remove-token": {
|
||||
"post": {
|
||||
"summary": "Create a remove token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -28909,7 +28909,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
|
||||
"get": {
|
||||
"summary": "Get a self-hosted runner for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -29054,7 +29054,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Delete a self-hosted runner from an enterprise",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -261079,28 +261079,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"409": {
|
||||
"description": "Conflict",
|
||||
"content": {
|
||||
@@ -261131,15 +261109,15 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
@@ -261506,28 +261484,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Resource not found",
|
||||
"content": {
|
||||
@@ -261558,15 +261514,15 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -333742,7 +333698,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-emails-for-authenticated",
|
||||
"operationId": "users/list-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
||||
@@ -333927,7 +333883,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/add-email-for-authenticated",
|
||||
"operationId": "users/add-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
||||
@@ -334215,7 +334171,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-email-for-authenticated",
|
||||
"operationId": "users/delete-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
||||
@@ -334704,7 +334660,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -335320,7 +335276,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -335663,7 +335619,7 @@
|
||||
"post": {
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -336072,7 +336028,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -336396,7 +336352,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -338898,7 +338854,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -338998,7 +338954,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -341850,7 +341806,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -342051,7 +342007,7 @@
|
||||
"post": {
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -342315,7 +342271,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -342488,7 +342444,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -344640,7 +344596,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-emails-for-authenticated",
|
||||
"operationId": "users/list-public-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
||||
@@ -350113,7 +350069,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -350231,7 +350187,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -24888,7 +24888,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runner groups for an enterprise",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25030,7 +25030,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Create a self-hosted runner group for an enterprise",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25175,7 +25175,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
|
||||
"get": {
|
||||
"summary": "Get a self-hosted runner group for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25272,7 +25272,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Update a self-hosted runner group for an enterprise",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25397,7 +25397,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Delete a self-hosted runner group from an enterprise",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25445,7 +25445,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
|
||||
"get": {
|
||||
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25624,7 +25624,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25701,7 +25701,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
|
||||
"put": {
|
||||
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25756,7 +25756,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25813,7 +25813,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runners in a group for an enterprise",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26028,7 +26028,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set self-hosted runners in a group for an enterprise",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26105,7 +26105,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
|
||||
"put": {
|
||||
"summary": "Add a self-hosted runner to a group for an enterprise",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26160,7 +26160,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26217,7 +26217,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runners for an enterprise",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26421,7 +26421,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/downloads": {
|
||||
"get": {
|
||||
"summary": "List runner applications for an enterprise",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26535,7 +26535,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/registration-token": {
|
||||
"post": {
|
||||
"summary": "Create a registration token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -27722,7 +27722,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/remove-token": {
|
||||
"post": {
|
||||
"summary": "Create a remove token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -28909,7 +28909,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
|
||||
"get": {
|
||||
"summary": "Get a self-hosted runner for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -29054,7 +29054,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Delete a self-hosted runner from an enterprise",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -264056,28 +264056,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"409": {
|
||||
"description": "Conflict",
|
||||
"content": {
|
||||
@@ -264108,15 +264086,15 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
@@ -264483,28 +264461,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Resource not found",
|
||||
"content": {
|
||||
@@ -264535,15 +264491,15 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -305551,7 +305507,16 @@
|
||||
{
|
||||
"name": "secret_type",
|
||||
"in": "query",
|
||||
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"in": "query",
|
||||
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
@@ -306120,6 +306085,9 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"304": {
|
||||
"description": "Not modified"
|
||||
},
|
||||
"404": {
|
||||
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
|
||||
},
|
||||
@@ -338294,7 +338262,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-emails-for-authenticated",
|
||||
"operationId": "users/list-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
||||
@@ -338479,7 +338447,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/add-email-for-authenticated",
|
||||
"operationId": "users/add-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
||||
@@ -338767,7 +338735,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-email-for-authenticated",
|
||||
"operationId": "users/delete-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
||||
@@ -339256,7 +339224,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -339872,7 +339840,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -340215,7 +340183,7 @@
|
||||
"post": {
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -340624,7 +340592,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -340948,7 +340916,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -343450,7 +343418,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -343550,7 +343518,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -346402,7 +346370,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -346603,7 +346571,7 @@
|
||||
"post": {
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -346867,7 +346835,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -347040,7 +347008,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -349192,7 +349160,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-emails-for-authenticated",
|
||||
"operationId": "users/list-public-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
||||
@@ -354665,7 +354633,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -354783,7 +354751,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -25796,7 +25796,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runner groups for an enterprise",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -25938,7 +25938,7 @@
|
||||
},
|
||||
"post": {
|
||||
"summary": "Create a self-hosted runner group for an enterprise",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26083,7 +26083,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
|
||||
"get": {
|
||||
"summary": "Get a self-hosted runner group for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26180,7 +26180,7 @@
|
||||
},
|
||||
"patch": {
|
||||
"summary": "Update a self-hosted runner group for an enterprise",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26305,7 +26305,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Delete a self-hosted runner group from an enterprise",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26353,7 +26353,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
|
||||
"get": {
|
||||
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26532,7 +26532,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26609,7 +26609,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
|
||||
"put": {
|
||||
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26664,7 +26664,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26721,7 +26721,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runners in a group for an enterprise",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -26936,7 +26936,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set self-hosted runners in a group for an enterprise",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -27013,7 +27013,7 @@
|
||||
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
|
||||
"put": {
|
||||
"summary": "Add a self-hosted runner to a group for an enterprise",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
|
||||
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -27068,7 +27068,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -27125,7 +27125,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runners for an enterprise",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -27329,7 +27329,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/downloads": {
|
||||
"get": {
|
||||
"summary": "List runner applications for an enterprise",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -27453,7 +27453,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/registration-token": {
|
||||
"post": {
|
||||
"summary": "Create a registration token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -28649,7 +28649,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/remove-token": {
|
||||
"post": {
|
||||
"summary": "Create a remove token for an enterprise",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
||||
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -29845,7 +29845,7 @@
|
||||
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
|
||||
"get": {
|
||||
"summary": "Get a self-hosted runner for an enterprise",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -29990,7 +29990,7 @@
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Delete a self-hosted runner from an enterprise",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
||||
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
|
||||
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
||||
"tags": [
|
||||
"enterprise-admin"
|
||||
@@ -270869,28 +270869,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"409": {
|
||||
"description": "Conflict",
|
||||
"content": {
|
||||
@@ -270921,15 +270899,15 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
@@ -271296,28 +271274,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Resource not found",
|
||||
"content": {
|
||||
@@ -271348,15 +271304,15 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "repos",
|
||||
"subcategory": "pages",
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -312997,7 +312953,16 @@
|
||||
{
|
||||
"name": "secret_type",
|
||||
"in": "query",
|
||||
"description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "resolution",
|
||||
"in": "query",
|
||||
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
@@ -313566,6 +313531,9 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"304": {
|
||||
"description": "Not modified"
|
||||
},
|
||||
"404": {
|
||||
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
|
||||
},
|
||||
@@ -346307,7 +346275,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-emails-for-authenticated",
|
||||
"operationId": "users/list-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
||||
@@ -346492,7 +346460,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/add-email-for-authenticated",
|
||||
"operationId": "users/add-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
||||
@@ -346780,7 +346748,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-email-for-authenticated",
|
||||
"operationId": "users/delete-email-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
||||
@@ -347269,7 +347237,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -347885,7 +347853,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -348228,7 +348196,7 @@
|
||||
"post": {
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -348637,7 +348605,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -348961,7 +348929,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -351473,7 +351441,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -351573,7 +351541,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -354435,7 +354403,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -354636,7 +354604,7 @@
|
||||
"post": {
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -354900,7 +354868,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -355073,7 +355041,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -357225,7 +357193,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-emails-for-authenticated",
|
||||
"operationId": "users/list-public-emails-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
||||
@@ -362732,7 +362700,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -362850,7 +362818,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
@@ -119420,6 +119420,149 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": {
|
||||
"post": {
|
||||
"summary": "Rerequest a check run",
|
||||
"description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
|
||||
"tags": [
|
||||
"checks"
|
||||
],
|
||||
"operationId": "checks/rerequest-run",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-run"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "check_run_id",
|
||||
"description": "check_run_id parameter",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
},
|
||||
"additionalProperties": false
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"title": "Basic Error",
|
||||
"description": "Basic Error",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation error if the check run is not rerequestable",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"title": "Basic Error",
|
||||
"description": "Basic Error",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Resource not found",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"title": "Basic Error",
|
||||
"description": "Basic Error",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
|
||||
],
|
||||
"category": "checks",
|
||||
"subcategory": "runs"
|
||||
}
|
||||
}
|
||||
},
|
||||
"/repos/{owner}/{repo}/check-suites": {
|
||||
"post": {
|
||||
"summary": "Create a check suite",
|
||||
@@ -237643,28 +237786,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"409": {
|
||||
"description": "Conflict",
|
||||
"content": {
|
||||
@@ -237695,13 +237816,6 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
}
|
||||
@@ -238070,28 +238184,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"415": {
|
||||
"description": "Preview header missing",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"message",
|
||||
"documentation_url"
|
||||
],
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"documentation_url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Resource not found",
|
||||
"content": {
|
||||
@@ -238122,13 +238214,6 @@
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"previews": [
|
||||
{
|
||||
"required": true,
|
||||
"name": "switcheroo",
|
||||
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
||||
}
|
||||
],
|
||||
"category": "repos",
|
||||
"subcategory": "pages"
|
||||
}
|
||||
@@ -309534,7 +309619,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-followed-by-authenticated",
|
||||
"operationId": "users/list-followed-by-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
||||
@@ -310150,7 +310235,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-gpg-keys-for-authenticated",
|
||||
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
||||
@@ -310493,7 +310578,7 @@
|
||||
"post": {
|
||||
"summary": "Create a GPG key for the authenticated user",
|
||||
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-gpg-key-for-authenticated",
|
||||
"operationId": "users/create-gpg-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -310902,7 +310987,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-gpg-key-for-authenticated",
|
||||
"operationId": "users/get-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -311226,7 +311311,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-gpg-key-for-authenticated",
|
||||
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
||||
@@ -313738,7 +313823,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/add-repo-to-installation",
|
||||
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#add-a-repository-to-an-app-installation"
|
||||
@@ -313838,7 +313923,7 @@
|
||||
"tags": [
|
||||
"apps"
|
||||
],
|
||||
"operationId": "apps/remove-repo-from-installation",
|
||||
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
||||
@@ -316689,7 +316774,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
||||
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
||||
@@ -316890,7 +316975,7 @@
|
||||
"post": {
|
||||
"summary": "Create a public SSH key for the authenticated user",
|
||||
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
@@ -317154,7 +317239,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -317327,7 +317412,7 @@
|
||||
"tags": [
|
||||
"users"
|
||||
],
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
||||
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
||||
@@ -324793,7 +324878,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/accept-invitation",
|
||||
"operationId": "repos/accept-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#accept-a-repository-invitation"
|
||||
@@ -324911,7 +324996,7 @@
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
"operationId": "repos/decline-invitation",
|
||||
"operationId": "repos/decline-invitation-for-authenticated-user",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#decline-a-repository-invitation"
|
||||
|
||||
Reference in New Issue
Block a user