{ "opencollection": "1.0.0", "info": { "name": "GitHub v3 REST API", "version": "1.1.4" }, "items": [ { "info": { "name": "Meta", "type": "folder" }, "items": [ { "info": { "name": "GitHub API Root", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/" }, "docs": "Get Hypermedia links to resources accessible in GitHub's REST API" }, { "info": { "name": "GitHub Get GitHub Enterprise Server Meta Information", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/meta" }, "docs": "GitHub Get GitHub Enterprise Server Meta Information" }, { "info": { "name": "GitHub Get Octocat", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/octocat", "params": [ { "name": "s", "value": "example_value", "type": "query", "description": "The words to show in Octocat's speech bubble" } ] }, "docs": "Get the octocat as ASCII art" }, { "info": { "name": "GitHub Get the Zen of GitHub", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/zen" }, "docs": "Get a random sentence from the Zen of GitHub" } ] }, { "info": { "name": "Enterprise-Admin", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Global Webhooks", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/admin/hooks", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Global Webhooks" }, { "info": { "name": "GitHub Create a Global Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/admin/hooks", "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Create a Global Webhook" }, { "info": { "name": "GitHub Get a Global Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/admin/hooks/:hook_id", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "GitHub Get a Global Webhook" }, { "info": { "name": "GitHub Update a Global Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/admin/hooks/:hook_id", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Parameters that are not provided will be overwritten with the default value or removed if no default exists." }, { "info": { "name": "GitHub Delete a Global Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/admin/hooks/:hook_id", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "GitHub Delete a Global Webhook" }, { "info": { "name": "GitHub Ping a Global Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/admin/hooks/:hook_id/pings", "params": [ { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the webhook." }, { "info": { "name": "GitHub List Public Keys", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/admin/keys", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "created", "type": "query" }, { "name": "since", "value": "example_value", "type": "query", "description": "Only show public keys accessed after the given time." } ] }, "docs": "GitHub List Public Keys" }, { "info": { "name": "GitHub Delete a Public Key", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/admin/keys/:key_ids", "params": [ { "name": "key_ids", "value": "", "type": "path", "description": "The unique identifier of the key." } ] }, "docs": "GitHub Delete a Public Key" }, { "info": { "name": "GitHub Update LDAP Mapping for a Team", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/admin/ldap/teams/:team_id/mapping", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping." }, { "info": { "name": "GitHub Sync LDAP Mapping for a Team", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/admin/ldap/teams/:team_id/sync", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." } ] }, "docs": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready." }, { "info": { "name": "GitHub Update LDAP Mapping for a User", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/admin/ldap/users/:username/mapping", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Update LDAP Mapping for a User" }, { "info": { "name": "GitHub Sync LDAP Mapping for a User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/admin/ldap/users/:username/sync", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready." }, { "info": { "name": "GitHub Create an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/admin/organizations", "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Create an Organization" }, { "info": { "name": "GitHub Update an Organization Name", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/admin/organizations/:org", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Update an Organization Name" }, { "info": { "name": "GitHub List Pre-receive Environments", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-environments", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "created", "type": "query" } ] }, "docs": "GitHub List Pre-receive Environments" }, { "info": { "name": "GitHub Create a Pre-receive Environment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-environments", "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Create a Pre-receive Environment" }, { "info": { "name": "GitHub Get a Pre-receive Environment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-environments/:pre_receive_environment_id", "params": [ { "name": "pre_receive_environment_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive environment." } ] }, "docs": "GitHub Get a Pre-receive Environment" }, { "info": { "name": "GitHub Update a Pre-receive Environment", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-environments/:pre_receive_environment_id", "params": [ { "name": "pre_receive_environment_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive environment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response." }, { "info": { "name": "GitHub Delete a Pre-receive Environment", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-environments/:pre_receive_environment_id", "params": [ { "name": "pre_receive_environment_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive environment." } ] }, "docs": "If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Cannot delete environment that has hooks_\n* _Cannot delete environment when download is in progress_" }, { "info": { "name": "GitHub Start a Pre-receive Environment Download", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-environments/:pre_receive_environment_id/downloads", "params": [ { "name": "pre_receive_environment_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive environment." } ] }, "docs": "Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_" }, { "info": { "name": "GitHub Get the Download Status for a Pre-receive Environment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-environments/:pre_receive_environment_id/downloads/latest", "params": [ { "name": "pre_receive_environment_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive environment." } ] }, "docs": "In addition to seeing the download status at the \"[Get a pre-receive environment](#get-a-pre-receive-environment)\" endpoint, there is also this separate endpoint for just the download status." }, { "info": { "name": "GitHub List Pre-receive Hooks", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-hooks", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "created", "type": "query", "description": "The property to sort the results by." } ] }, "docs": "GitHub List Pre-receive Hooks" }, { "info": { "name": "GitHub Create a Pre-receive Hook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-hooks", "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Create a Pre-receive Hook" }, { "info": { "name": "GitHub Get a Pre-receive Hook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "GitHub Get a Pre-receive Hook" }, { "info": { "name": "GitHub Update a Pre-receive Hook", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Update a Pre-receive Hook" }, { "info": { "name": "GitHub Delete a Pre-receive Hook", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/admin/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "GitHub Delete a Pre-receive Hook" }, { "info": { "name": "GitHub List Personal Access Tokens", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/admin/tokens", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists personal access tokens for all users, including admin users." }, { "info": { "name": "GitHub Delete a Personal Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/admin/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path", "description": "The unique identifier of the token." } ] }, "docs": "Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error." }, { "info": { "name": "GitHub Create a User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/admin/users", "body": { "type": "json", "data": "{}" } }, "docs": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be creat" }, { "info": { "name": "GitHub Update the Username for a User", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/admin/users/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Update the Username for a User" }, { "info": { "name": "GitHub Delete a User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/admin/users/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own." }, { "info": { "name": "GitHub Create an Impersonation OAuth Token", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/admin/users/:username/authorizations", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Create an Impersonation OAuth Token" }, { "info": { "name": "GitHub Delete an Impersonation OAuth Token", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/admin/users/:username/authorizations", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "GitHub Delete an Impersonation OAuth Token" }, { "info": { "name": "GitHub Get the Global Announcement Banner", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/announcement" }, "docs": "Gets the current message and expiration date of the global announcement banner in your enterprise." }, { "info": { "name": "GitHub Set the Global Announcement Banner", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/enterprise/announcement", "body": { "type": "json", "data": "{}" } }, "docs": "Sets the message and expiration time for the global announcement banner in your enterprise." }, { "info": { "name": "GitHub Remove the Global Announcement Banner", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/enterprise/announcement" }, "docs": "Removes the global announcement banner in your enterprise." }, { "info": { "name": "GitHub Get License Information", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/settings/license" }, "docs": "GitHub Get License Information" }, { "info": { "name": "GitHub Get All Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/all" }, "docs": "GitHub Get All Statistics" }, { "info": { "name": "GitHub Get Comment Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/comments" }, "docs": "GitHub Get Comment Statistics" }, { "info": { "name": "GitHub Get Gist Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/gists" }, "docs": "GitHub Get Gist Statistics" }, { "info": { "name": "GitHub Get Hooks Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/hooks" }, "docs": "GitHub Get Hooks Statistics" }, { "info": { "name": "GitHub Get Issue Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/issues" }, "docs": "GitHub Get Issue Statistics" }, { "info": { "name": "GitHub Get Milestone Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/milestones" }, "docs": "GitHub Get Milestone Statistics" }, { "info": { "name": "GitHub Get Organization Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/orgs" }, "docs": "GitHub Get Organization Statistics" }, { "info": { "name": "GitHub Get Pages Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/pages" }, "docs": "GitHub Get Pages Statistics" }, { "info": { "name": "GitHub Get Pull Request Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/pulls" }, "docs": "GitHub Get Pull Request Statistics" }, { "info": { "name": "GitHub Get Repository Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/repos" }, "docs": "GitHub Get Repository Statistics" }, { "info": { "name": "GitHub Get Users Statistics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprise/stats/users" }, "docs": "GitHub Get Users Statistics" }, { "info": { "name": "GitHub Get GitHub Actions Permissions for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/permissions", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Set GitHub Actions Permissions for an Enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/permissions", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub List Selected Organizations Enabled for GitHub Actions in an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/permissions/organizations", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Set Selected Organizations Enabled for GitHub Actions in an Enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/permissions/organizations", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Enable a Selected Organization for GitHub Actions in an Enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/permissions/organizations/:org_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "org_id", "value": "", "type": "path", "description": "The unique identifier of the organization." } ] }, "docs": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Disable a Selected Organization for GitHub Actions in an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/permissions/organizations/:org_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "org_id", "value": "", "type": "path", "description": "The unique identifier of the organization." } ] }, "docs": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Get Allowed Actions for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/permissions/selected-actions", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Set Allowed Actions for an Enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/permissions/selected-actions", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub List Self-hosted Runner Groups for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "visible_to_organization", "value": "", "type": "query", "description": "Only return runner groups that are allowed to be used by this organization." } ] }, "docs": "Lists all self-hosted runner groups for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Self-hosted Runner Group for an Enterprise", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new self-hosted runner group for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Self-hosted Runner Group for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ] }, "docs": "Gets a specific self-hosted runner group for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Update a Self-hosted Runner Group for an Enterprise", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Self-hosted Runner Group from an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ] }, "docs": "Deletes a self-hosted runner group for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub List Organization Access to a Self-hosted Runner Group in an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id/organizations", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the organizations with access to a self-hosted runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Set Organization Access for a Self-hosted Runner Group in an Enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id/organizations", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Add Organization Access to a Self-hosted Runner Group in an Enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id/organizations/:org_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "org_id", "value": "", "type": "path", "description": "The unique identifier of the organization." } ] }, "docs": "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\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Remove Organization Access to a Self-hosted Runner Group in an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id/organizations/:org_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "org_id", "value": "", "type": "path", "description": "The unique identifier of the organization." } ] }, "docs": "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\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub List Self-hosted Runners in a Group for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id/runners", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the self-hosted runners that are in a specific enterprise group.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Set Self-hosted Runners in a Group for an Enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id/runners", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Add a Self-hosted Runner to a Group for an Enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id/runners/:runner_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Remove a Self-hosted Runner from a Group for an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runner-groups/:runner_group_id/runners/:runner_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub List Self-hosted Runners for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all self-hosted runners configured for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub List Runner Applications for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners/downloads", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Lists binaries for the runner application that you can download and run.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Registration Token for an Enterprise", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners/registration-token", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nExample 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```\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Remove Token for an Enterprise", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners/remove-token", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "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\nExample 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```\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Self-hosted Runner for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners/:runner_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Gets a specific self-hosted runner configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Self-hosted Runner from an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners/:runner_id", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "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\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub List Labels for a Self-hosted Runner for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners/:runner_id/labels", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Lists all labels for a self-hosted runner configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Add Custom Labels to a Self-hosted Runner for an Enterprise", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners/:runner_id/labels", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add custom labels to a self-hosted runner configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Set Custom Labels for a Self-hosted Runner for an Enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners/:runner_id/labels", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Remove All Custom Labels from a Self-hosted Runner for an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners/:runner_id/labels", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Remove a Custom Label from a Self-hosted Runner for an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/runners/:runner_id/labels/:name", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." }, { "name": "name", "value": "", "type": "path", "description": "The name of a self-hosted runner's custom label." } ] }, "docs": "Remove a custom label from a self-hosted runner configured\nin an enterprise. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Get the Audit Log for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/audit-log", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "phrase", "value": "", "type": "query", "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log)." }, { "name": "include", "value": "", "type": "query", "description": "The event types to include:\n\n- `web` - returns web (non-Git) events.\n- `git` - returns Git events.\n- `all` - returns both web and Git events.\n\nThe default is `web`." }, { "name": "after", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor." }, { "name": "before", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor." }, { "name": "order", "value": "", "type": "query", "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Gets the audit log for an enterprise.\n\nThe authenticated user must be an enterprise admin to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Get Code Security and Analysis Features for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/code_security_and_analysis", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Update Code Security and Analysis Features for an Enterprise", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/code_security_and_analysis", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Enable or Disable a Security Feature", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/:security_product/:enablement", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "security_product", "value": "", "type": "path", "description": "The security feature to enable or disable." }, { "name": "enablement", "value": "", "type": "path", "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the enterprise.\n`disable_all` means to disable the specified security feature for all repositories in the enterprise." } ] }, "docs": "Enables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Get GHES Node Metadata for All Nodes", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/manage/v1/config/nodes", "params": [ { "name": "uuid", "value": "", "type": "query", "description": "The UUID which identifies a node." }, { "name": "cluster_roles", "value": "", "type": "query", "description": "The cluster roles from the cluster configuration file." } ] }, "docs": "Get node metadata for all configured nodes in the current cluster. For more information, see \"[About clustering](https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/configuring-clustering/about-clustering).\"" }, { "info": { "name": "GitHub Get the Status of Services Running on All Replica Nodes", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/manage/v1/replication/status", "params": [ { "name": "uuid", "value": "", "type": "query", "description": "The UUID which identifies a node." }, { "name": "cluster_roles", "value": "", "type": "query", "description": "The cluster roles from the cluster configuration file." } ] }, "docs": "Gets the status of all services running on each replica node.\nThis endpoint may take several seconds to reply." }, { "info": { "name": "GitHub Get All GHES Release Versions for All Nodes", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/manage/v1/version", "params": [ { "name": "uuid", "value": "", "type": "query", "description": "The UUID which identifies a node." }, { "name": "cluster_roles", "value": "", "type": "query", "description": "The cluster roles from the cluster configuration file." } ] }, "docs": "Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.9/admin/all-releases).\"" }, { "info": { "name": "GitHub List Pre-receive Hooks for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/pre-receive-hooks", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "created", "type": "query", "description": "The sort order for the response collection." } ] }, "docs": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed." }, { "info": { "name": "GitHub Get a Pre-receive Hook for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "GitHub Get a Pre-receive Hook for an Organization" }, { "info": { "name": "GitHub Update Pre-receive Hook Enforcement for an Organization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`" }, { "info": { "name": "GitHub Remove Pre-receive Hook Enforcement for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "Removes any overrides for this hook at the org level for this org." }, { "info": { "name": "GitHub List Pre-receive Hooks for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pre-receive-hooks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "created", "type": "query" } ] }, "docs": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed." }, { "info": { "name": "GitHub Get a Pre-receive Hook for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "GitHub Get a Pre-receive Hook for a Repository" }, { "info": { "name": "GitHub Update Pre-receive Hook Enforcement for a Repository", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`" }, { "info": { "name": "GitHub Remove Pre-receive Hook Enforcement for a Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pre_receive_hook_id", "value": "", "type": "path", "description": "The unique identifier of the pre-receive hook." } ] }, "docs": "Deletes any overridden enforcement on this repository for the specified hook.\n\nResponds with effective values inherited from owner and/or global level." }, { "info": { "name": "GitHub Provision a SCIM Enterprise Group", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups", "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user." }, { "info": { "name": "GitHub Get SCIM Provisioning Information for an Enterprise Group", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." }, { "name": "excludedAttributes", "value": "", "type": "query", "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group." }, { "info": { "name": "GitHub Set SCIM Information for a Provisioned Enterprise Group", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-" }, { "info": { "name": "GitHub Update an Attribute for a SCIM Enterprise Group", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add gro" }, { "info": { "name": "GitHub Delete a SCIM Group from an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id", "params": [ { "name": "scim_group_id", "value": "", "type": "path", "description": "A unique identifier of the SCIM group." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\n Deletes a SCIM group from an enterprise." }, { "info": { "name": "GitHub List SCIM Provisioned Identities for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users", "params": [ { "name": "filter", "value": "example_value", "type": "query", "description": "If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `userName`, `externalId`, `id`, and `displayName`. For example, `?filter=\"externalId eq '9138790-10932-109120392-12321'\"`." }, { "name": "startIndex", "value": "", "type": "query", "description": "Used for pagination: the starting index of the first result to return when paginating through values." }, { "name": "count", "value": "", "type": "query", "description": "Used for pagination: the number of results to return per page." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permane" }, { "info": { "name": "GitHub Provision a SCIM Enterprise User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users", "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The u" }, { "info": { "name": "GitHub Get SCIM Provisioning Information for an Enterprise User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user." }, { "info": { "name": "GitHub Set SCIM Information for a Provisioned Enterprise User", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) end" }, { "info": { "name": "GitHub Update an Attribute for a SCIM Enterprise User", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `" }, { "info": { "name": "GitHub Delete a SCIM User from an Enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/scim/v2/Users/:scim_user_id", "params": [ { "name": "scim_user_id", "value": "", "type": "path", "description": "The unique identifier of the SCIM user." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action." }, { "info": { "name": "GitHub Get the Configuration Status", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/setup/api/configcheck" }, "docs": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| - | |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly" }, { "info": { "name": "GitHub Start a Configuration Process", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/setup/api/configure" }, "docs": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:" }, { "info": { "name": "GitHub Get the Maintenance Status", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/setup/api/maintenance" }, "docs": "Check your installation's maintenance status:" }, { "info": { "name": "GitHub Enable or Disable Maintenance Mode", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/setup/api/maintenance", "body": { "type": "form-urlencoded", "data": [ { "name": "maintenance", "value": "" } ] } }, "docs": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)." }, { "info": { "name": "GitHub Get Settings", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/setup/api/settings" }, "docs": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings).\n\n**Note:** You cannot retrieve the management console password with the Enterprise administration API." }, { "info": { "name": "GitHub Set Settings", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/setup/api/settings", "body": { "type": "form-urlencoded", "data": [ { "name": "settings", "value": "" } ] } }, "docs": "Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings).\n\n**Notes:**\n\n- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl" }, { "info": { "name": "GitHub Get All Authorized SSH Keys", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/setup/api/settings/authorized-keys" }, "docs": "GitHub Get All Authorized SSH Keys" }, { "info": { "name": "GitHub Add an Authorized SSH Key", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/setup/api/settings/authorized-keys", "body": { "type": "form-urlencoded", "data": [ { "name": "authorized_key", "value": "" } ] } }, "docs": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)." }, { "info": { "name": "GitHub Remove an Authorized SSH Key", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/setup/api/settings/authorized-keys", "body": { "type": "form-urlencoded", "data": [ { "name": "authorized_key", "value": "" } ] } }, "docs": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)." }, { "info": { "name": "GitHub Create a GitHub License", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/setup/api/start", "body": { "type": "multipart-form", "data": [ { "name": "license", "type": "text", "value": "" }, { "name": "password", "type": "text", "value": "" }, { "name": "settings", "type": "text", "value": "" } ] } }, "docs": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing th" }, { "info": { "name": "GitHub Upgrade a License", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/setup/api/upgrade", "body": { "type": "multipart-form", "data": [ { "name": "license", "type": "text", "value": "" } ] } }, "docs": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F)." }, { "info": { "name": "GitHub Promote a User to Be a Site Administrator", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/users/:username/site_admin", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"" }, { "info": { "name": "GitHub Demote a Site Administrator", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/users/:username/site_admin", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "You can demote any user account except your own." }, { "info": { "name": "GitHub Suspend a User", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/users/:username/suspended", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any para" }, { "info": { "name": "GitHub Unsuspend a User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/users/:username/suspended", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API." } ] }, { "info": { "name": "Apps", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app" }, "docs": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-g" }, { "info": { "name": "GitHub Create a GitHub App from a Manifest", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/app-manifests/:code/conversions", "params": [ { "name": "code", "value": "example_value", "type": "path" } ] }, "docs": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`." }, { "info": { "name": "GitHub Get a Webhook Configuration for an App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/hook/config" }, "docs": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Update a Webhook Configuration for an App", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/app/hook/config", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub List Deliveries for an App Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/hook/deliveries", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "cursor", "value": "", "type": "query", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors." }, { "name": "redelivery", "value": "true", "type": "query" } ] }, "docs": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Get a Delivery for an App Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/hook/deliveries/:delivery_id", "params": [ { "name": "delivery_id", "value": "", "type": "path" } ] }, "docs": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Redeliver a Delivery for an App Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/app/hook/deliveries/:delivery_id/attempts", "params": [ { "name": "delivery_id", "value": "", "type": "path" } ] }, "docs": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub List Installation Requests for the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/installation-requests", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all the pending installation requests for the authenticated GitHub App." }, { "info": { "name": "GitHub List Installations for the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/installations", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "outdated", "value": "2026-04-17T12:00:00Z", "type": "query" } ] }, "docs": "The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Get an Installation for the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/installations/:installation_id", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." } ] }, "docs": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Delete an Installation for the Authenticated App", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/app/installations/:installation_id", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." } ] }, "docs": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Create an Installation Access Token for an App", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/app/installations/:installation_id/access_tokens", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. \n\nOptionally, you can use the `repositories` or " }, { "info": { "name": "GitHub Suspend an App Installation", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/app/installations/:installation_id/suspended", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." } ] }, "docs": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Unsuspend an App Installation", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/app/installations/:installation_id/suspended", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." } ] }, "docs": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Delete an App Authorization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/applications/:client_id/grant", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the GitHub app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeletin" }, { "info": { "name": "GitHub Check a Token", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/applications/:client_id/token", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the GitHub app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is it" }, { "info": { "name": "GitHub Reset a Token", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/applications/:client_id/token", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the GitHub app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the usernam" }, { "info": { "name": "GitHub Delete an App Token", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/applications/:client_id/token", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the GitHub app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password." }, { "info": { "name": "GitHub Create a Scoped Access Token", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/applications/:client_id/token/scoped", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the GitHub app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.\n\nYou must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication)\nwhen accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App\nas t" }, { "info": { "name": "GitHub Get an App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/apps/:app_slug", "params": [ { "name": "app_slug", "value": "", "type": "path" } ] }, "docs": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`)." }, { "info": { "name": "GitHub List Repositories Accessible to the App Installation", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/installation/repositories", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List repositories that an app installation can access." }, { "info": { "name": "GitHub Revoke an Installation Access Token", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/installation/token" }, "docs": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint." }, { "info": { "name": "GitHub Get an Organization Installation for the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/installation", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Get a Repository Installation for the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/installation", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub List App Installations Accessible to the User Access Token", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/installations", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key." }, { "info": { "name": "GitHub List Repositories Accessible to the User Access Token", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/installations/:installation_id/repositories", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nThe access the user has to each repository is included in the hash under the `permissions` key." }, { "info": { "name": "GitHub Add a Repository to an App Installation", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/user/installations/:installation_id/repositories/:repository_id", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Add a single repository to an installation. The authenticated user must have admin access to the repository." }, { "info": { "name": "GitHub Remove a Repository from an App Installation", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/installations/:installation_id/repositories/:repository_id", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.9/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint." }, { "info": { "name": "GitHub Get a User Installation for the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/installation", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." } ] }, { "info": { "name": "Oauth-Authorizations", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Your Grants", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/applications/grants", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "client_id", "value": "12345678", "type": "query", "description": "The client ID of your GitHub app." } ] }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.gith" }, { "info": { "name": "GitHub Get a Single Grant", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/applications/grants/:grant_id", "params": [ { "name": "grant_id", "value": "", "type": "path", "description": "The unique identifier of the grant." } ] }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://" }, { "info": { "name": "GitHub Delete a Grant", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/applications/grants/:grant_id", "params": [ { "name": "grant_id", "value": "", "type": "path", "description": "The unique identifier of the grant." } ] }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.gith" }, { "info": { "name": "GitHub List Your Authorizations", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/authorizations", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "client_id", "value": "12345678", "type": "query", "description": "The client ID of your GitHub app." } ] }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://" }, { "info": { "name": "GitHub Create a New Authorization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/authorizations", "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.githu" }, { "info": { "name": "GitHub Get-or-create an Authorization for a Specific App", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/authorizations/clients/:client_id", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the OAuth app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.gith" }, { "info": { "name": "GitHub Get-or-create an Authorization for a Specific App and Fingerprint", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/authorizations/clients/:client_id/:fingerprint", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the OAuth app." }, { "name": "fingerprint", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.gith" }, { "info": { "name": "GitHub Get a Single Authorization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/authorizations/:authorization_id", "params": [ { "name": "authorization_id", "value": "", "type": "path", "description": "The unique identifier of the authorization." } ] }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://" }, { "info": { "name": "GitHub Update an Existing Authorization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/authorizations/:authorization_id", "params": [ { "name": "authorization_id", "value": "", "type": "path", "description": "The unique identifier of the authorization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.gith" }, { "info": { "name": "GitHub Delete an Authorization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/authorizations/:authorization_id", "params": [ { "name": "authorization_id", "value": "", "type": "path", "description": "The unique identifier of the authorization." } ] }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://" } ] }, { "info": { "name": "Codes-Of-Conduct", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get All Codes of Conduct", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/codes_of_conduct" }, "docs": "Returns array of all GitHub's codes of conduct." }, { "info": { "name": "GitHub Get a Code of Conduct", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/codes_of_conduct/:key", "params": [ { "name": "key", "value": "example_value", "type": "path" } ] }, "docs": "Returns information about the specified GitHub code of conduct." } ] }, { "info": { "name": "Emojis", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get Emojis", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/emojis" }, "docs": "Lists all the emojis available to use on GitHub Enterprise Server." } ] }, { "info": { "name": "Actions", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get GitHub Actions Cache Usage for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/cache/usage", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Get GitHub Actions Cache Usage Policy for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/cache/usage-policy", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Gets the GitHub Actions cache usage policy for an enterprise.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Set GitHub Actions Cache Usage Policy for an Enterprise", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/cache/usage-policy", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the GitHub Actions cache usage policy for an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Get Default Workflow Permissions for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/permissions/workflow", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ] }, "docs": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"" }, { "info": { "name": "GitHub Set Default Workflow Permissions for an Enterprise", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/actions/permissions/workflow", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\n" }, { "info": { "name": "GitHub Get GitHub Actions Cache Usage for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/cache/usage", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Repositories with GitHub Actions Cache Usage for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/cache/usage-by-repository", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get GitHub Actions Permissions for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API." }, { "info": { "name": "GitHub Set GitHub Actions Permissions for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Selected Repositories Enabled for GitHub Actions in an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set Selected Repositories Enabled for GitHub Actions in an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Enable a Selected Repository for GitHub Actions in an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Disable a Selected Repository for GitHub Actions in an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get Allowed Actions for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/selected-actions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API." }, { "info": { "name": "GitHub Set Allowed Actions for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/selected-actions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `pattern" }, { "info": { "name": "GitHub Get Default Workflow Permissions for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/workflow", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." }, { "info": { "name": "GitHub Set Default Workflow Permissions for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/permissions/workflow", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAut" }, { "info": { "name": "GitHub List Self-hosted Runner Groups for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "visible_to_repository", "value": "", "type": "query", "description": "Only return runner groups that are allowed to be used by this repository." } ] }, "docs": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Self-hosted Runner Group for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Self-hosted Runner Group for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ] }, "docs": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Update a Self-hosted Runner Group for an Organization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Self-hosted Runner Group from an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ] }, "docs": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Repository Access to a Self-hosted Runner Group in an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set Repository Access for a Self-hosted Runner Group in an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Add Repository Access to a Self-hosted Runner Group in an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Adds a repository to the list of repositories 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 organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Remove Repository Access to a Self-hosted Runner Group in an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Removes a repository from the list of selected repositories 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 organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Self-hosted Runners in a Group for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set Self-hosted Runners in a Group for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Add a Self-hosted Runner to a Group for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners/:runner_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Remove a Self-hosted Runner from a Group for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners/:runner_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_group_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner group." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Self-hosted Runners for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub List Runner Applications for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/downloads", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Create a Registration Token for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/registration-token", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Remove Token for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/remove-token", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need" }, { "info": { "name": "GitHub Get a Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Delete a Self-hosted Runner from an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Labels for a Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id/labels", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Add Custom Labels to a Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id/labels", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set Custom Labels for a Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id/labels", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Remove All Custom Labels from a Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id/labels", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Remove a Custom Label from a Self-hosted Runner for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runners/:runner_id/labels/:name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." }, { "name": "name", "value": "", "type": "path", "description": "The name of a self-hosted runner's custom label." } ] }, "docs": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub List Organization Secrets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Get an Organization Public Key", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/public-key", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Organization Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create or Update an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:" }, { "info": { "name": "GitHub Delete an Organization Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Selected Repositories for an Organization Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Set Selected Repositories for an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this en" }, { "info": { "name": "GitHub Add Selected Repository to an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to " }, { "info": { "name": "GitHub Remove Selected Repository from an Organization Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/secrets/:secret_name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoi" }, { "info": { "name": "GitHub List Organization Variables", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Create an Organization Variable", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Organization Variable", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ] }, "docs": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Update an Organization Variable", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Delete an Organization Variable", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ] }, "docs": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Selected Repositories for an Organization Variable", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Set Selected Repositories for an Organization Variable", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub Add Selected Repository to an Organization Variable", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `r" }, { "info": { "name": "GitHub Remove Selected Repository from an Organization Variable", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/variables/:name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required." }, { "info": { "name": "GitHub List Artifacts for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/artifacts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "name", "value": "", "type": "query", "description": "The name field of an artifact. When specified, only artifacts with this name will be returned." } ] }, "docs": "Lists all artifacts for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Get an Artifact", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/artifacts/:artifact_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "artifact_id", "value": "", "type": "path", "description": "The unique identifier of the artifact." } ] }, "docs": "Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete an Artifact", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/artifacts/:artifact_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "artifact_id", "value": "", "type": "path", "description": "The unique identifier of the artifact." } ] }, "docs": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Download an Artifact", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "artifact_id", "value": "", "type": "path", "description": "The unique identifier of the artifact." }, { "name": "archive_format", "value": "example_value", "type": "path" } ] }, "docs": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get GitHub Actions Cache Usage for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/cache/usage", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get GitHub Actions Cache Usage Policy for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/cache/usage-policy", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets GitHub Actions cache usage policy for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Set GitHub Actions Cache Usage Policy for a Repository", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/cache/usage-policy", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets GitHub Actions cache usage policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List GitHub Actions Caches for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/caches", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "ref", "value": "", "type": "query", "description": "The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`." }, { "name": "key", "value": "", "type": "query", "description": "An explicit key or prefix for identifying the cache" }, { "name": "sort", "value": "", "type": "query", "description": "The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." } ] }, "docs": "Lists the GitHub Actions caches for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete GitHub Actions Caches for a Repository (using a Cache Key)", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/caches", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "key", "value": "", "type": "query", "description": "A key for identifying the cache." }, { "name": "ref", "value": "", "type": "query", "description": "The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`." } ] }, "docs": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a GitHub Actions Cache for a Repository (using a Cache ID)", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/caches/:cache_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "cache_id", "value": "", "type": "path", "description": "The unique identifier of the GitHub Actions cache." } ] }, "docs": "Deletes a GitHub Actions cache for a repository, using a cache ID.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Job for a Workflow Run", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/jobs/:job_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "job_id", "value": "", "type": "path", "description": "The unique identifier of the job." } ] }, "docs": "Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Download Job Logs for a Workflow Run", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/jobs/:job_id/logs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "job_id", "value": "", "type": "path", "description": "The unique identifier of the job." } ] }, "docs": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Re-run a Job from a Workflow Run", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/jobs/:job_id/rerun", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "job_id", "value": "", "type": "path", "description": "The unique identifier of the job." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Re-run a job and its dependent jobs in a workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get the Customization Template for an OIDC Subject Claim for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/oidc/customization/sub", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Set the Customization Template for an OIDC Subject Claim for a Repository", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/oidc/customization/sub", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Repository Organization Secrets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/organization-secrets", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Repository Organization Variables", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/organization-variables", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all organization variables shared with a repository.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get GitHub Actions Permissions for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/permissions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API." }, { "info": { "name": "GitHub Set GitHub Actions Permissions for a Repository", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/permissions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get the Level of Access for Workflows Outside of the Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/permissions/access", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-" }, { "info": { "name": "GitHub Set the Level of Access for Workflows Outside of the Repository", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/permissions/access", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-" }, { "info": { "name": "GitHub Get Allowed Actions for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/permissions/selected-actions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API." }, { "info": { "name": "GitHub Set Allowed Actions for a Repository", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/permissions/selected-actions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `" }, { "info": { "name": "GitHub Get Default Workflow Permissions for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/permissions/workflow", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-g" }, { "info": { "name": "GitHub Set Default Workflow Permissions for a Repository", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/permissions/workflow", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-git" }, { "info": { "name": "GitHub List Self-hosted Runners for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all self-hosted runners configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Runner Applications for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners/downloads", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Registration Token for a Repository", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners/registration-token", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Remove Token for a Repository", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners/remove-token", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the" }, { "info": { "name": "GitHub Get a Self-hosted Runner for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners/:runner_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Gets a specific self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Self-hosted Runner from a Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners/:runner_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Labels for a Self-hosted Runner for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners/:runner_id/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Lists all labels for a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Add Custom Labels to a Self-hosted Runner for a Repository", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners/:runner_id/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds custom labels to a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Set Custom Labels for a Self-hosted Runner for a Repository", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners/:runner_id/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Remove All Custom Labels from a Self-hosted Runner for a Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners/:runner_id/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." } ] }, "docs": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Remove a Custom Label from a Self-hosted Runner for a Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runners/:runner_id/labels/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "runner_id", "value": "", "type": "path", "description": "Unique identifier of the self-hosted runner." }, { "name": "name", "value": "", "type": "path", "description": "The name of a self-hosted runner's custom label." } ] }, "docs": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Workflow Runs for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "actor", "value": "", "type": "query", "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run." }, { "name": "branch", "value": "", "type": "query", "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`." }, { "name": "event", "value": "", "type": "query", "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"" }, { "name": "status", "value": "", "type": "query", "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "created", "value": "", "type": "query", "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.9/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"" }, { "name": "exclude_pull_requests", "value": "", "type": "query", "description": "If `true` pull requests are omitted from the response (empty array)." }, { "name": "check_suite_id", "value": "", "type": "query", "description": "Returns workflow runs with the `check_suite_id` that you specify." }, { "name": "head_sha", "value": "", "type": "query", "description": "Only returns workflow runs that are associated with the specified `head_sha`." } ] }, "docs": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Get a Workflow Run", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." }, { "name": "exclude_pull_requests", "value": "", "type": "query", "description": "If `true` pull requests are omitted from the response (empty array)." } ] }, "docs": "Gets a specific workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Delete a Workflow Run", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." } ] }, "docs": "Deletes a specific workflow run.\n\nAnyone with write access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get the Review History for a Workflow Run", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/approvals", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." } ] }, "docs": "Anyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub List Workflow Run Artifacts", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/artifacts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "name", "value": "", "type": "query", "description": "The name field of an artifact. When specified, only artifacts with this name will be returned." } ] }, "docs": "Lists artifacts for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Get a Workflow Run Attempt", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/attempts/:attempt_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." }, { "name": "attempt_number", "value": "", "type": "path", "description": "The attempt number of the workflow run." }, { "name": "exclude_pull_requests", "value": "", "type": "query", "description": "If `true` pull requests are omitted from the response (empty array)." } ] }, "docs": "Gets a specific workflow run attempt.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub List Jobs for a Workflow Run Attempt", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/attempts/:attempt_number/jobs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." }, { "name": "attempt_number", "value": "", "type": "path", "description": "The attempt number of the workflow run." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Download Workflow Run Attempt Logs", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/attempts/:attempt_number/logs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." }, { "name": "attempt_number", "value": "", "type": "path", "description": "The attempt number of the workflow run." } ] }, "docs": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Cancel a Workflow Run", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/cancel", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." } ] }, "docs": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Jobs for a Workflow Run", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/jobs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." }, { "name": "filter", "value": "latest", "type": "query", "description": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Download Workflow Run Logs", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/logs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." } ] }, "docs": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete Workflow Run Logs", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/logs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." } ] }, "docs": "Deletes all logs for a workflow run.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get Pending Deployments for a Workflow Run", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/pending_deployments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." } ] }, "docs": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Review Pending Deployments for a Workflow Run", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/pending_deployments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Re-run a Workflow", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/rerun", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Re-runs your workflow run using its `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Re-run Failed Jobs from a Workflow Run", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/rerun-failed-jobs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Repository Secrets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/secrets", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Repository Public Key", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/secrets/public-key", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Repository Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/secrets/:secret_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Gets a single repository secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create or Update a Repository Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/secrets/:secret_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` sc" }, { "info": { "name": "GitHub Delete a Repository Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/secrets/:secret_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Deletes a secret in a repository using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Repository Variables", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/variables", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all repository variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Repository Variable", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/variables", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Repository Variable", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/variables/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ] }, "docs": "Gets a specific variable in a repository.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Update a Repository Variable", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/variables/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Repository Variable", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/variables/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ] }, "docs": "Deletes a repository variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Repository Workflows", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/workflows", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the workflows in a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Get a Workflow", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/workflows/:workflow_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string." } ] }, "docs": "Gets a specific workflow. You can replace `workflow_id` with the workflow\nfile name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Disable a Workflow", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/workflows/:workflow_id/disable", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string." } ] }, "docs": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Workflow Dispatch Event", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/workflows/:workflow_id/dispatches", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workf" }, { "info": { "name": "GitHub Enable a Workflow", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/workflows/:workflow_id/enable", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string." } ] }, "docs": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Workflow Runs for a Workflow", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/workflows/:workflow_id/runs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string." }, { "name": "actor", "value": "", "type": "query", "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run." }, { "name": "branch", "value": "", "type": "query", "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`." }, { "name": "event", "value": "", "type": "query", "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"" }, { "name": "status", "value": "", "type": "query", "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "created", "value": "", "type": "query", "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.9/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"" }, { "name": "exclude_pull_requests", "value": "", "type": "query", "description": "If `true` pull requests are omitted from the response (empty array)." }, { "name": "check_suite_id", "value": "", "type": "query", "description": "Returns workflow runs with the `check_suite_id` that you specify." }, { "name": "head_sha", "value": "", "type": "query", "description": "Only returns workflow runs that are associated with the specified `head_sha`." } ] }, "docs": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope" }, { "info": { "name": "GitHub List Environment Secrets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/secrets", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Environment Public Key", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/secrets/public-key", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." } ] }, "docs": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Environment Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/secrets/:secret_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create or Update an Environment Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/secrets/:secret_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` " }, { "info": { "name": "GitHub Delete an Environment Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/secrets/:secret_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Environment Variables", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/variables", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create an Environment Variable", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/variables", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Environment Variable", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/variables/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." } ] }, "docs": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Update an Environment Variable", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/variables/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete an Environment Variable", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/variables/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "name", "value": "", "type": "path", "description": "The name of the variable." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." } ] }, "docs": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." } ] }, { "info": { "name": "Code-Scanning", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Code Scanning Alerts for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/code-scanning/alerts", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "tool_name", "value": "", "type": "query", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both." }, { "name": "tool_guid", "value": "", "type": "query", "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both." }, { "name": "before", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "after", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "state", "value": "open", "type": "query", "description": "If specified, only code scanning alerts with this state will be returned." }, { "name": "sort", "value": "created", "type": "query", "description": "The property by which to sort the results." } ] }, "docs": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a" }, { "info": { "name": "GitHub List Code Scanning Alerts for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/code-scanning/alerts", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "tool_name", "value": "", "type": "query", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both." }, { "name": "tool_guid", "value": "", "type": "query", "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both." }, { "name": "before", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "after", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "state", "value": "open", "type": "query", "description": "If specified, only code scanning alerts with this state will be returned." }, { "name": "sort", "value": "created", "type": "query", "description": "The property by which to sort the results." }, { "name": "severity", "value": "example_value", "type": "query", "description": "If specified, only code scanning alerts with this severity will be returned." } ] }, "docs": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be" }, { "info": { "name": "GitHub List Code Scanning Alerts for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/alerts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "tool_name", "value": "", "type": "query", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both." }, { "name": "tool_guid", "value": "", "type": "query", "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "ref", "value": "", "type": "query", "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "created", "type": "query", "description": "The property by which to sort the results." }, { "name": "state", "value": "open", "type": "query", "description": "If specified, only code scanning alerts with this state will be returned." }, { "name": "severity", "value": "example_value", "type": "query", "description": "If specified, only code scanning alerts with this severity will be returned." } ] }, "docs": "Lists code scanning alerts.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used `ref` in the request).\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories." }, { "info": { "name": "GitHub Get a Code Scanning Alert", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/alerts/:alert_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "alert_number", "value": "", "type": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation." } ] }, "docs": "Gets a single code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories." }, { "info": { "name": "GitHub Update a Code Scanning Alert", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/alerts/:alert_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "alert_number", "value": "", "type": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories." }, { "info": { "name": "GitHub List Instances of a Code Scanning Alert", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/alerts/:alert_number/instances", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "alert_number", "value": "", "type": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "ref", "value": "", "type": "query", "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`." } ] }, "docs": "Lists all instances of the specified code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories." }, { "info": { "name": "GitHub List Code Scanning Analyses for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/analyses", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "tool_name", "value": "", "type": "query", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both." }, { "name": "tool_guid", "value": "", "type": "query", "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "ref", "value": "main", "type": "query", "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`." }, { "name": "sarif_id", "value": "12345678", "type": "query", "description": "Filter analyses belonging to the same SARIF upload." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "sort", "value": "created", "type": "query", "description": "The property by which to sort the results." } ] }, "docs": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n**Deprecation notice**:\nThe `tool_name` field is depre" }, { "info": { "name": "GitHub Get a Code Scanning Analysis for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/analyses/:analysis_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "analysis_id", "value": "42", "type": "path", "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation." } ] }, "docs": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpo" }, { "info": { "name": "GitHub Delete a Code Scanning Analysis from a Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/analyses/:analysis_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "analysis_id", "value": "42", "type": "path", "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation." }, { "name": "confirm_delete", "value": "example_value", "type": "query", "description": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`" } ] }, "docs": "Deletes a specified code scanning analysis from a repository.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository wi" }, { "info": { "name": "GitHub Get a Code Scanning Default Setup Configuration", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/default-setup", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories." }, { "info": { "name": "GitHub Update a Code Scanning Default Setup Configuration", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/default-setup", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories." }, { "info": { "name": "GitHub Upload an Analysis as SARIF Data", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/sarifs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull" }, { "info": { "name": "GitHub Get Information About a SARIF Upload", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/code-scanning/sarifs/:sarif_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "sarif_id", "value": "12345678", "type": "path", "description": "The SARIF ID obtained after uploading." } ] }, "docs": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository).\"\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this en" } ] }, { "info": { "name": "Dependabot", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Dependabot Alerts for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/dependabot/alerts", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "state", "value": "", "type": "query", "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`" }, { "name": "severity", "value": "", "type": "query", "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`" }, { "name": "ecosystem", "value": "", "type": "query", "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`" }, { "name": "package", "value": "", "type": "query", "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned." }, { "name": "scope", "value": "", "type": "query", "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned." }, { "name": "sort", "value": "", "type": "query", "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "before", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "after", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "first", "value": "", "type": "query", "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results." }, { "name": "last", "value": "", "type": "query", "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-wit" }, { "info": { "name": "GitHub List Dependabot Alerts for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/alerts", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "state", "value": "", "type": "query", "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`" }, { "name": "severity", "value": "", "type": "query", "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`" }, { "name": "ecosystem", "value": "", "type": "query", "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`" }, { "name": "package", "value": "", "type": "query", "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned." }, { "name": "scope", "value": "", "type": "query", "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned." }, { "name": "sort", "value": "", "type": "query", "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "before", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "after", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "first", "value": "", "type": "query", "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results." }, { "name": "last", "value": "", "type": "query", "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead." }, { "info": { "name": "GitHub List Organization Secrets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Organization Public Key", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/public-key", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Get an Organization Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Create or Update an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Delete an Organization Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Selected Repositories for an Organization Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set Selected Repositories for an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Add Selected Repository to an Organization Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub Remove Selected Repository from an Organization Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." }, { "name": "repository_id", "value": "42", "type": "path" } ] }, "docs": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint." }, { "info": { "name": "GitHub List Dependabot Alerts for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependabot/alerts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "state", "value": "", "type": "query", "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`" }, { "name": "severity", "value": "", "type": "query", "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`" }, { "name": "ecosystem", "value": "", "type": "query", "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`" }, { "name": "package", "value": "", "type": "query", "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned." }, { "name": "manifest", "value": "", "type": "query", "description": "A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned." }, { "name": "scope", "value": "", "type": "query", "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned." }, { "name": "sort", "value": "", "type": "query", "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "page", "value": "42", "type": "query", "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead." }, { "name": "per_page", "value": "42", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "before", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "after", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "first", "value": "", "type": "query", "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results." }, { "name": "last", "value": "", "type": "query", "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results." } ] }, "docs": "OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead." }, { "info": { "name": "GitHub Get a Dependabot Alert", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependabot/alerts/:alert_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "alert_number", "value": "", "type": "path", "description": "The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in the response from the\n`GET /repos/{owner}/{repo}/dependabot/alerts` operation." } ] }, "docs": "OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead." }, { "info": { "name": "GitHub Update a Dependabot Alert", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependabot/alerts/:alert_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "alert_number", "value": "", "type": "path", "description": "The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in the response from the\n`GET /repos/{owner}/{repo}/dependabot/alerts` operation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to us" }, { "info": { "name": "GitHub List Repository Secrets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependabot/secrets", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Repository Public Key", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependabot/secrets/public-key", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets. Anyone with read access\nto the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private." }, { "info": { "name": "GitHub Get a Repository Secret", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependabot/secrets/:secret_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Gets a single repository secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create or Update a Repository Secret", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependabot/secrets/:secret_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Repository Secret", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependabot/secrets/:secret_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "secret_name", "value": "", "type": "path", "description": "The name of the secret." } ] }, "docs": "Deletes a secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." } ] }, { "info": { "name": "Secret-Scanning", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Secret Scanning Alerts for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/secret-scanning/alerts", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "state", "value": "", "type": "query", "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state." }, { "name": "secret_type", "value": "", "type": "query", "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types." }, { "name": "resolution", "value": "", "type": "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`." }, { "name": "sort", "value": "", "type": "query", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "before", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "after", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-" }, { "info": { "name": "GitHub List Secret Scanning Alerts for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/secret-scanning/alerts", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "state", "value": "", "type": "query", "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state." }, { "name": "secret_type", "value": "", "type": "query", "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types." }, { "name": "resolution", "value": "", "type": "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`." }, { "name": "sort", "value": "", "type": "query", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "before", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string." }, { "name": "after", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string." } ] }, "docs": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead." }, { "info": { "name": "GitHub List Secret Scanning Alerts for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/secret-scanning/alerts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "state", "value": "", "type": "query", "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state." }, { "name": "secret_type", "value": "", "type": "query", "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types." }, { "name": "resolution", "value": "", "type": "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`." }, { "name": "sort", "value": "", "type": "query", "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "before", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string." }, { "name": "after", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string." } ] }, "docs": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead." }, { "info": { "name": "GitHub Get a Secret Scanning Alert", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/secret-scanning/alerts/:alert_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "alert_number", "value": "", "type": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation." } ] }, "docs": "Gets a single secret scanning alert detected in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead." }, { "info": { "name": "GitHub Update a Secret Scanning Alert", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/secret-scanning/alerts/:alert_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "alert_number", "value": "", "type": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead." }, { "info": { "name": "GitHub List Locations for a Secret Scanning Alert", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/secret-scanning/alerts/:alert_number/locations", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "alert_number", "value": "", "type": "path", "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all locations for a given secret scanning alert for an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead." } ] }, { "info": { "name": "Billing", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get GitHub Advanced Security Active Committers for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/enterprises/:enterprise/settings/billing/advanced-security", "params": [ { "name": "enterprise", "value": "", "type": "path", "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field." }, { "info": { "name": "GitHub Get GitHub Advanced Security Active Committers for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/settings/billing/advanced-security", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Gets the GitHub Advanced Security active committers for an organization per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.\n\nIf this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so th" } ] }, { "info": { "name": "Activity", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Public Events", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/events", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago." }, { "info": { "name": "GitHub Get Feeds", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/feeds" }, "docs": "GitHub Enterprise Server provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* *" }, { "info": { "name": "GitHub List Public Events for a Network of Repositories", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/networks/:owner/:repo/events", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Public Events for a Network of Repositories" }, { "info": { "name": "GitHub List Notifications for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/notifications", "params": [ { "name": "all", "value": "", "type": "query", "description": "If `true`, show notifications marked as read." }, { "name": "participating", "value": "", "type": "query", "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "before", "value": "", "type": "query", "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "42", "type": "query", "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List all notifications for the current user, sorted by most recently updated." }, { "info": { "name": "GitHub Mark Notifications as Read", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/notifications", "body": { "type": "json", "data": "{}" } }, "docs": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user)" }, { "info": { "name": "GitHub Get a Thread", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/notifications/threads/:thread_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user))." } ] }, "docs": "Gets information about a notification thread." }, { "info": { "name": "GitHub Mark a Thread as Read", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/notifications/threads/:thread_id", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user))." } ] }, "docs": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications." }, { "info": { "name": "GitHub Get a Thread Subscription for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/notifications/threads/:thread_id/subscription", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user))." } ] }, "docs": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread." }, { "info": { "name": "GitHub Set a Thread Subscription", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/notifications/threads/:thread_id/subscription", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user))." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a t" }, { "info": { "name": "GitHub Delete a Thread Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/notifications/threads/:thread_id/subscription", "params": [ { "name": "thread_id", "value": "", "type": "path", "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user))." } ] }, "docs": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`." }, { "info": { "name": "GitHub List Public Organization Events", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/events", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Public Organization Events" }, { "info": { "name": "GitHub List Repository Events", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/events", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n" }, { "info": { "name": "GitHub List Repository Notifications for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/notifications", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "all", "value": "", "type": "query", "description": "If `true`, show notifications marked as read." }, { "name": "participating", "value": "", "type": "query", "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "before", "value": "", "type": "query", "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all notifications for the current user in the specified repository." }, { "info": { "name": "GitHub Mark Repository Notifications as Read", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/notifications", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-repository-not" }, { "info": { "name": "GitHub List Stargazers", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/stargazers", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created." }, { "info": { "name": "GitHub List Watchers", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/subscribers", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the people watching the specified repository." }, { "info": { "name": "GitHub Get a Repository Subscription", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/subscription", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets information about whether the authenticated user is subscribed to the repository." }, { "info": { "name": "GitHub Set a Repository Subscription", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/subscription", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#delete-a-repository-subscription) completely." }, { "info": { "name": "GitHub Delete a Repository Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/subscription", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#set-a-repository-subscription)." }, { "info": { "name": "GitHub List Repositories Starred by the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/starred", "params": [ { "name": "sort", "value": "", "type": "query", "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created." }, { "info": { "name": "GitHub Check if a Repository is Starred by the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/starred/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Whether the authenticated user has starred the repository." }, { "info": { "name": "GitHub Star a Repository for the Authenticated User", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/user/starred/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"" }, { "info": { "name": "GitHub Unstar a Repository for the Authenticated User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/starred/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Unstar a repository that the authenticated user has previously starred." }, { "info": { "name": "GitHub List Repositories Watched by the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/subscriptions", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists repositories the authenticated user is watching." }, { "info": { "name": "GitHub List Events for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/events", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events." }, { "info": { "name": "GitHub List Organization Events for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/events/orgs/:org", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "This is the user's organization dashboard. You must be authenticated as the user to view this." }, { "info": { "name": "GitHub List Public Events for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/events/public", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Public Events for a User" }, { "info": { "name": "GitHub List Events Received by the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/received_events", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events." }, { "info": { "name": "GitHub List Public Events Received by a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/received_events/public", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Public Events Received by a User" }, { "info": { "name": "GitHub List Repositories Starred by a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/starred", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "sort", "value": "", "type": "query", "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created." }, { "info": { "name": "GitHub List Repositories Watched by a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/subscriptions", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists repositories a user is watching." } ] }, { "info": { "name": "Gists", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Gists for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gists", "params": [ { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:" }, { "info": { "name": "GitHub Create a Gist", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/gists", "body": { "type": "json", "data": "{}" } }, "docs": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally." }, { "info": { "name": "GitHub List Public Gists", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gists/public", "params": [ { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page." }, { "info": { "name": "GitHub List Starred Gists", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gists/starred", "params": [ { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List the authenticated user's starred gists:" }, { "info": { "name": "GitHub Get a Gist", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." } ] }, "docs": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any i" }, { "info": { "name": "GitHub Update a Gist", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.\n\nAt least one of `description` or `files` is required.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+js" }, { "info": { "name": "GitHub Delete a Gist", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." } ] }, "docs": "GitHub Delete a Gist" }, { "info": { "name": "GitHub List Gist Comments", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/comments", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contain" }, { "info": { "name": "GitHub Create a Gist Comment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/comments", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains" }, { "info": { "name": "GitHub Get a Gist Comment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/comments/:comment_id", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ] }, "docs": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains an" }, { "info": { "name": "GitHub Update a Gist Comment", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/comments/:comment_id", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains" }, { "info": { "name": "GitHub Delete a Gist Comment", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/comments/:comment_id", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ] }, "docs": "GitHub Delete a Gist Comment" }, { "info": { "name": "GitHub List Gist Commits", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/commits", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Gist Commits" }, { "info": { "name": "GitHub List Gist Forks", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/forks", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Gist Forks" }, { "info": { "name": "GitHub Fork a Gist", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/forks", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." } ] }, "docs": "GitHub Fork a Gist" }, { "info": { "name": "GitHub Check if a Gist is Starred", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/star", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." } ] }, "docs": "GitHub Check if a Gist is Starred" }, { "info": { "name": "GitHub Star a Gist", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/star", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." } ] }, "docs": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"" }, { "info": { "name": "GitHub Unstar a Gist", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/star", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." } ] }, "docs": "GitHub Unstar a Gist" }, { "info": { "name": "GitHub Get a Gist Revision", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gists/:gist_id/:sha", "params": [ { "name": "gist_id", "value": "", "type": "path", "description": "The unique identifier of the gist." }, { "name": "sha", "value": "abc123def456789012345678901234567890", "type": "path" } ] }, "docs": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist conta" }, { "info": { "name": "GitHub List Gists for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/gists", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists public gists for the specified user:" } ] }, { "info": { "name": "Gitignore", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get All Gitignore Templates", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gitignore/templates" }, "docs": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-for-the-authenticated-user)." }, { "info": { "name": "GitHub Get a Gitignore Template", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/gitignore/templates/:name", "params": [ { "name": "name", "value": "octocat", "type": "path" } ] }, "docs": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents." } ] }, { "info": { "name": "Issues", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Issues Assigned to the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/issues", "params": [ { "name": "filter", "value": "assigned", "type": "query", "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the issues to return." }, { "name": "labels", "value": "", "type": "query", "description": "A list of comma separated label names. Example: `bug,ui,@high`" }, { "name": "sort", "value": "created", "type": "query", "description": "What to sort results by." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "collab", "value": "true", "type": "query" }, { "name": "orgs", "value": "true", "type": "query" }, { "name": "owned", "value": "true", "type": "query" }, { "name": "pulls", "value": "true", "type": "query" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `" }, { "info": { "name": "GitHub List Organization Issues Assigned to the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/issues", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "filter", "value": "assigned", "type": "query", "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the issues to return." }, { "name": "labels", "value": "", "type": "query", "description": "A list of comma separated label names. Example: `bug,ui,@high`" }, { "name": "sort", "value": "created", "type": "query", "description": "What to sort results by." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.g" }, { "info": { "name": "GitHub List Assignees", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/assignees", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the [available assignees](https://docs.github.com/enterprise-server@3.9/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository." }, { "info": { "name": "GitHub Check if a User Can Be Assigned", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/assignees/:assignee", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "assignee", "value": "example_value", "type": "path" } ] }, "docs": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned." }, { "info": { "name": "GitHub List Repository Issues", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "milestone", "value": "example_value", "type": "query", "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the issues to return." }, { "name": "assignee", "value": "example_value", "type": "query", "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user." }, { "name": "creator", "value": "example_value", "type": "query", "description": "The user that created the issue." }, { "name": "mentioned", "value": "example_value", "type": "query", "description": "A user that's mentioned in the issue." }, { "name": "labels", "value": "", "type": "query", "description": "A list of comma separated label names. Example: `bug,ui,@high`" }, { "name": "sort", "value": "created", "type": "query", "description": "What to sort results by." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github" }, { "info": { "name": "GitHub Create an Issue", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.9/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[" }, { "info": { "name": "GitHub List Issue Comments for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "sort", "value": "", "type": "query", "description": "The property to sort the results by." }, { "name": "direction", "value": "asc", "type": "query", "description": "Either `asc` or `desc`. Ignored without the `sort` parameter." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown" }, { "info": { "name": "GitHub Get an Issue Comment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/comments/:comment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ] }, "docs": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass" }, { "info": { "name": "GitHub Update an Issue Comment", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/comments/:comment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not p" }, { "info": { "name": "GitHub Delete an Issue Comment", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/comments/:comment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ] }, "docs": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request." }, { "info": { "name": "GitHub List Issue Events for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/events", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists events for a repository." }, { "info": { "name": "GitHub Get an Issue Event", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/events/:event_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "event_id", "value": "42", "type": "path" } ] }, "docs": "Gets a single event by the event id." }, { "info": { "name": "GitHub Get an Issue", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ] }, "docs": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.9/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from" }, { "info": { "name": "GitHub Update an Issue", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Issue owners and users with push access can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text" }, { "info": { "name": "GitHub Add Assignees to an Issue", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/assignees", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced." }, { "info": { "name": "GitHub Remove Assignees from an Issue", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/assignees", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes one or more assignees from an issue." }, { "info": { "name": "GitHub Check if a User Can Be Assigned to a Issue", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/assignees/:assignee", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." }, { "name": "assignee", "value": "example_value", "type": "path" } ] }, "docs": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned." }, { "info": { "name": "GitHub List Issue Comments", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include " }, { "info": { "name": "GitHub Create an Issue Comment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/res" }, { "info": { "name": "GitHub List Issue Events", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/events", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all events for an issue." }, { "info": { "name": "GitHub List Labels for an Issue", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all labels for an issue." }, { "info": { "name": "GitHub Add Labels to an Issue", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. " }, { "info": { "name": "GitHub Set Labels for an Issue", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes any previous labels and sets the new labels for an issue." }, { "info": { "name": "GitHub Remove All Labels from an Issue", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ] }, "docs": "Removes all labels from an issue." }, { "info": { "name": "GitHub Remove a Label from an Issue", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/labels/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." }, { "name": "name", "value": "octocat", "type": "path" } ] }, "docs": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist." }, { "info": { "name": "GitHub Lock an Issue", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/lock", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"" }, { "info": { "name": "GitHub Unlock an Issue", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/lock", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ] }, "docs": "Users with push access can unlock an issue's conversation." }, { "info": { "name": "GitHub List Timeline Events for an Issue", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/timeline", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List all timeline events for an issue." }, { "info": { "name": "GitHub List Labels for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all labels for a repository." }, { "info": { "name": "GitHub Create a Label", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/)." }, { "info": { "name": "GitHub Get a Label", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/labels/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "name", "value": "octocat", "type": "path" } ] }, "docs": "Gets a label using the given name." }, { "info": { "name": "GitHub Update a Label", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/labels/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "name", "value": "octocat", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a label using the given label name." }, { "info": { "name": "GitHub Delete a Label", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/labels/:name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "name", "value": "octocat", "type": "path" } ] }, "docs": "Deletes a label using the given label name." }, { "info": { "name": "GitHub List Milestones", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/milestones", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "state", "value": "open", "type": "query", "description": "The state of the milestone. Either `open`, `closed`, or `all`." }, { "name": "sort", "value": "due_on", "type": "query", "description": "What to sort results by. Either `due_on` or `completeness`." }, { "name": "direction", "value": "asc", "type": "query", "description": "The direction of the sort. Either `asc` or `desc`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists milestones for a repository." }, { "info": { "name": "GitHub Create a Milestone", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/milestones", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a milestone." }, { "info": { "name": "GitHub Get a Milestone", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/milestones/:milestone_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "milestone_number", "value": "", "type": "path", "description": "The number that identifies the milestone." } ] }, "docs": "Gets a milestone using the given milestone number." }, { "info": { "name": "GitHub Update a Milestone", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/milestones/:milestone_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "milestone_number", "value": "", "type": "path", "description": "The number that identifies the milestone." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Update a Milestone" }, { "info": { "name": "GitHub Delete a Milestone", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/milestones/:milestone_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "milestone_number", "value": "", "type": "path", "description": "The number that identifies the milestone." } ] }, "docs": "Deletes a milestone using the given milestone number." }, { "info": { "name": "GitHub List Labels for Issues in a Milestone", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/milestones/:milestone_number/labels", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "milestone_number", "value": "", "type": "path", "description": "The number that identifies the milestone." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists labels for issues in a milestone." }, { "info": { "name": "GitHub List User Account Issues Assigned to the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/issues", "params": [ { "name": "filter", "value": "assigned", "type": "query", "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the issues to return." }, { "name": "labels", "value": "", "type": "query", "description": "A list of comma separated label names. Example: `bug,ui,@high`" }, { "name": "sort", "value": "created", "type": "query", "description": "What to sort results by." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull reques" } ] }, { "info": { "name": "Licenses", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get All Commonly Used Licenses", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/licenses", "params": [ { "name": "featured", "value": "true", "type": "query" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"" }, { "info": { "name": "GitHub Get a License", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/licenses/:license", "params": [ { "name": "license", "value": "example_value", "type": "path" } ] }, "docs": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"" }, { "info": { "name": "GitHub Get the License for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/license", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to" } ] }, { "info": { "name": "Markdown", "type": "folder" }, "items": [ { "info": { "name": "GitHub Render a Markdown Document", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/markdown", "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Render a Markdown Document" }, { "info": { "name": "GitHub Render a Markdown Document in Raw Mode", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/markdown/raw" }, "docs": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less." } ] }, { "info": { "name": "Orgs", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Organizations", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/organizations", "params": [ { "name": "since", "value": "", "type": "query", "description": "An organization ID. Only return organizations with an ID greater than this ID." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations." }, { "info": { "name": "GitHub Deprecated - List Custom Repository Roles in an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/organizations/:organization_id/custom_roles", "params": [ { "name": "organization_id", "value": "12345678", "type": "path", "description": "The unique identifier of the organization." } ] }, "docs": "**Note**: This operation is deprecated and will be removed in the future.\nUse the \"[List custom repository roles](https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organ" }, { "info": { "name": "GitHub Get an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.9/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need" }, { "info": { "name": "GitHub Update an Organization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see t" }, { "info": { "name": "GitHub Delete an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-server@3.9/site-policy/github-terms/github-terms-of-service" }, { "info": { "name": "GitHub Get Announcement Banner for Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/announcement", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint." }, { "info": { "name": "GitHub Set Announcement Banner for Organization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/announcement", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the announcement banner to display for the organization." }, { "info": { "name": "GitHub Remove Announcement Banner from Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/announcement", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Removes the announcement banner currently set for the organization." }, { "info": { "name": "GitHub Get the Audit Log for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/audit-log", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "phrase", "value": "", "type": "query", "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." }, { "name": "include", "value": "", "type": "query", "description": "The event types to include:\n\n- `web` - returns web (non-Git) events.\n- `git` - returns Git events.\n- `all` - returns both web and Git events.\n\nThe default is `web`." }, { "name": "after", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor." }, { "name": "before", "value": "", "type": "query", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor." }, { "name": "order", "value": "", "type": "query", "description": "The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`.\n\nThe default is `desc`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter event" }, { "info": { "name": "GitHub List Custom Repository Roles in an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/custom-repository-roles", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin" }, { "info": { "name": "GitHub Create a Custom Repository Role", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/custom-repository-roles", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` " }, { "info": { "name": "GitHub Get a Custom Repository Role", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/custom-repository-roles/:role_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." } ] }, "docs": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access to" }, { "info": { "name": "GitHub Update a Custom Repository Role", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/custom-repository-roles/:role_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:or" }, { "info": { "name": "GitHub Delete a Custom Repository Role", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/custom-repository-roles/:role_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "role_id", "value": "", "type": "path", "description": "The unique identifier of the role." } ] }, "docs": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this" }, { "info": { "name": "GitHub List Organization Webhooks", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Organization Webhooks" }, { "info": { "name": "GitHub Create an Organization Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Here's how you can create a hook that posts payloads in JSON format:" }, { "info": { "name": "GitHub Get an Organization Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\"" }, { "info": { "name": "GitHub Update an Organization Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization).\"" }, { "info": { "name": "GitHub Delete an Organization Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "GitHub Delete an Organization Webhook" }, { "info": { "name": "GitHub Get a Webhook Configuration for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/config", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint." }, { "info": { "name": "GitHub Update a Webhook Configuration for an Organization", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/config", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint." }, { "info": { "name": "GitHub List Deliveries for an Organization Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/deliveries", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "cursor", "value": "", "type": "query", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors." }, { "name": "redelivery", "value": "true", "type": "query" } ] }, "docs": "Returns a list of webhook deliveries for a webhook configured in an organization." }, { "info": { "name": "GitHub Get a Webhook Delivery for an Organization Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/deliveries/:delivery_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." }, { "name": "delivery_id", "value": "", "type": "path" } ] }, "docs": "Returns a delivery for a webhook configured in an organization." }, { "info": { "name": "GitHub Redeliver a Delivery for an Organization Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/deliveries/:delivery_id/attempts", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." }, { "name": "delivery_id", "value": "", "type": "path" } ] }, "docs": "Redeliver a delivery for a webhook configured in an organization." }, { "info": { "name": "GitHub Ping an Organization Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/hooks/:hook_id/pings", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the hook." }, { "info": { "name": "GitHub List App Installations for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/installations", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint." }, { "info": { "name": "GitHub List Organization Members", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/members", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "filter", "value": "2fa_disabled", "type": "query", "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners." }, { "name": "role", "value": "all", "type": "query", "description": "Filter members returned by their role." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned." }, { "info": { "name": "GitHub Check Organization Membership for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/members/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Check if a user is, publicly or privately, a member of the organization." }, { "info": { "name": "GitHub Remove an Organization Member", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/members/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories." }, { "info": { "name": "GitHub Get Organization Membership for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/memberships/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status." }, { "info": { "name": "GitHub Set Organization Membership for a User", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/memberships/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership" }, { "info": { "name": "GitHub Remove Organization Membership for a User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/memberships/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases." }, { "info": { "name": "GitHub List Outside Collaborators for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/outside_collaborators", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "filter", "value": "2fa_disabled", "type": "query", "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List all users who are outside collaborators of an organization." }, { "info": { "name": "GitHub Convert an Organization Member to Outside Collaborator", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/outside_collaborators/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.9/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restrict" }, { "info": { "name": "GitHub Remove Outside Collaborator from an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/outside_collaborators/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Removing a user from this list will remove them from all the organization's repositories." }, { "info": { "name": "GitHub List Public Organization Members", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/public_members", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Members of an organization can choose to have their membership publicized or not." }, { "info": { "name": "GitHub Check Public Organization Membership for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/public_members/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Check if the provided user is a public member of the organization." }, { "info": { "name": "GitHub Set Public Organization Membership for the Authenticated User", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/public_members/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"" }, { "info": { "name": "GitHub Remove Public Organization Membership for the Authenticated User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/public_members/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default." }, { "info": { "name": "GitHub List Repository Fine-grained Permissions for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/repository-fine-grained-permissions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need th" }, { "info": { "name": "GitHub List Security Manager Teams", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/security-managers", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to " }, { "info": { "name": "GitHub Add a Security Manager Team", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/security-managers/teams/:team_slug", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." } ] }, "docs": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpo" }, { "info": { "name": "GitHub Remove a Security Manager Team", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/security-managers/teams/:team_slug", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." } ] }, "docs": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:" }, { "info": { "name": "GitHub Enable or Disable a Security Feature for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/:security_product/:enablement", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "security_product", "value": "", "type": "path", "description": "The security feature to enable or disable." }, { "name": "enablement", "value": "", "type": "path", "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization." } ] }, "docs": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and per" }, { "info": { "name": "GitHub List Organization Memberships for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/memberships/orgs", "params": [ { "name": "state", "value": "active", "type": "query", "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all of the authenticated user's organization memberships." }, { "info": { "name": "GitHub Get an Organization Membership for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/memberships/orgs/:org", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization." }, { "info": { "name": "GitHub Update an Organization Membership for the Authenticated User", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/user/memberships/orgs/:org", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization." }, { "info": { "name": "GitHub List Organizations for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/orgs", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a" }, { "info": { "name": "GitHub List Organizations for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/orgs", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List [public organization memberships](https://docs.github.com/enterprise-server@3.9/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-the-authe" } ] }, { "info": { "name": "Oidc", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get the Customization Template for an OIDC Subject Claim for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/oidc/customization/sub", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint." }, { "info": { "name": "GitHub Set the Customization Template for an OIDC Subject Claim for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/oidc/customization/sub", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint." } ] }, { "info": { "name": "Packages", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get List of Conflicting Packages During Docker Migration for Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/docker/conflicts", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint." }, { "info": { "name": "GitHub List Packages for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages", "params": [ { "name": "package_type", "value": "npm", "type": "query", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "visibility", "value": "", "type": "query", "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"" }, { "name": "page", "value": "42", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "42", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packag" }, { "info": { "name": "GitHub Get a Package for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissio" }, { "info": { "name": "GitHub Delete a Package for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registrie" }, { "info": { "name": "GitHub Restore a Package for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name/restore", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "token", "value": "example_value", "type": "query", "description": "package token" } ] }, "docs": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this\nscenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\nThe authenti" }, { "info": { "name": "GitHub List Package Versions for a Package Owned by an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name/versions", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "state", "value": "active", "type": "query", "description": "The state of the package, either active or deleted." } ] }, "docs": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-p" }, { "info": { "name": "GitHub Get a Package Version for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name/versions/:package_version_id", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#p" }, { "info": { "name": "GitHub Delete Package Version for an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name/versions/:package_version_id", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package." }, { "info": { "name": "GitHub Restore Package Version for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/packages/:package_type/:package_name/versions/:package_version_id/restore", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this\nscenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\nThe" }, { "info": { "name": "GitHub Get List of Conflicting Packages During Docker Migration for Authenticated-user", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/docker/conflicts" }, "docs": "Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint." }, { "info": { "name": "GitHub List Packages for the Authenticated User's Namespace", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/packages", "params": [ { "name": "package_type", "value": "npm", "type": "query", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "visibility", "value": "", "type": "query", "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissio" }, { "info": { "name": "GitHub Get a Package for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/packages/:package_type/:package_name", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." } ] }, "docs": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-fo" }, { "info": { "name": "GitHub Delete a Package for the Authenticated User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/packages/:package_type/:package_name", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." } ] }, "docs": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list the" }, { "info": { "name": "GitHub Restore a Package for the Authenticated User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/packages/:package_type/:package_name/restore", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "token", "value": "example_value", "type": "query", "description": "package token" } ] }, "docs": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this\nscenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\nOAuth a" }, { "info": { "name": "GitHub List Package Versions for a Package Owned by the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/packages/:package_type/:package_name/versions", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "state", "value": "active", "type": "query", "description": "The state of the package, either active or deleted." } ] }, "docs": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for" }, { "info": { "name": "GitHub Get a Package Version for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/packages/:package_type/:package_name/versions/:package_version_id", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permis" }, { "info": { "name": "GitHub Delete a Package Version for the Authenticated User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/packages/:package_type/:package_name/versions/:package_version_id", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `" }, { "info": { "name": "GitHub Restore a Package Version for the Authenticated User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/packages/:package_type/:package_name/versions/:package_version_id/restore", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this\nscenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespac" }, { "info": { "name": "GitHub Get List of Conflicting Packages During Docker Migration for User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/docker/conflicts", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint." }, { "info": { "name": "GitHub List Packages for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/packages", "params": [ { "name": "package_type", "value": "npm", "type": "query", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "visibility", "value": "", "type": "query", "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"" }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-pe" }, { "info": { "name": "GitHub Get a Package for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/packages/:package_type/:package_name", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-fo" }, { "info": { "name": "GitHub Delete a Package for a User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/users/:username/packages/:package_type/:package_name", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/lea" }, { "info": { "name": "GitHub Restore a Package for a User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/users/:username/packages/:package_type/:package_name/restore", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "token", "value": "example_value", "type": "query", "description": "package token" } ] }, "docs": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this\nscenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\nIf the `package_type" }, { "info": { "name": "GitHub List Package Versions for a Package Owned by a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/packages/:package_type/:package_name/versions", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-fo" }, { "info": { "name": "GitHub Get a Package Version for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/packages/:package_type/:package_name/versions/:package_version_id", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permi" }, { "info": { "name": "GitHub Delete Package Version for a User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/users/:username/packages/:package_type/:package_name/versions/:package_version_id", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/en" }, { "info": { "name": "GitHub Restore Package Version for a User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/users/:username/packages/:package_type/:package_name/versions/:package_version_id/restore", "params": [ { "name": "package_type", "value": "", "type": "path", "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry." }, { "name": "package_name", "value": "", "type": "path", "description": "The name of the package." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "package_version_id", "value": "", "type": "path", "description": "Unique identifier of the package version." } ] }, "docs": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this\nscenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\nIf the `pac" } ] }, { "info": { "name": "Teams", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get an External Group", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/external-group/:group_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "group_id", "value": "", "type": "path", "description": "The unique identifier of the group." } ] }, "docs": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation." }, { "info": { "name": "GitHub List External Groups in an Organization", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/external-groups", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "42", "type": "query", "description": "Page token" }, { "name": "display_name", "value": "octocat", "type": "query", "description": "Limits the list to groups containing the text in the group name" } ] }, "docs": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](ht" }, { "info": { "name": "GitHub List Teams", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all teams in an organization that are visible to the authenticated user." }, { "info": { "name": "GitHub Create a Team", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-server@3.9/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional arr" }, { "info": { "name": "GitHub Get a Team by Name", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." } ] }, "docs": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`." }, { "info": { "name": "GitHub Update a Team", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`." }, { "info": { "name": "GitHub Delete a Team", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." } ] }, "docs": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`." }, { "info": { "name": "GitHub List Discussions", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "pinned", "value": "example_value", "type": "query", "description": "Pinned discussions only filter" } ] }, "docs": "List all discussions on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Discussion", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for u" }, { "info": { "name": "GitHub Get a Discussion", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." } ] }, "docs": "Get a specific discussion on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Update a Discussion", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Discussion", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." } ] }, "docs": "Delete a discussion from a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub List Discussion Comments", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List all comments on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Discussion Comment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using" }, { "info": { "name": "GitHub Get a Discussion Comment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." } ] }, "docs": "Get a specific comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Update a Discussion Comment", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits the body text of a discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Discussion Comment", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." } ] }, "docs": "Deletes a comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub List a Connection Between an External Group and a Team", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/external-groups", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." } ] }, "docs": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation." }, { "info": { "name": "GitHub Update the Connection Between an External Group and a Team", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/external-groups", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation." }, { "info": { "name": "GitHub Remove the Connection Between an External Group and a Team", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/external-groups", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." } ] }, "docs": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub List Team Members", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/members", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "role", "value": "member", "type": "query", "description": "Filters members returned by their role in the team." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user." }, { "info": { "name": "GitHub Get Team Membership for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/memberships/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Cre" }, { "info": { "name": "GitHub Add or Update Team Membership for a User", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/memberships/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provi" }, { "info": { "name": "GitHub Remove Team Membership for a User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/memberships/:username", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/github" }, { "info": { "name": "GitHub List Team Projects", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/projects", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`." }, { "info": { "name": "GitHub Check Team Permissions for a Project", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/projects/:project_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`." }, { "info": { "name": "GitHub Add or Update Team Project Permissions", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/projects/:project_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`." }, { "info": { "name": "GitHub Remove a Project from a Team", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/projects/:project_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/t" }, { "info": { "name": "GitHub List Team Repositories", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/repos", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`." }, { "info": { "name": "GitHub Check Team Permissions for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/repos/:owner/:repo", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permiss" }, { "info": { "name": "GitHub Add or Update Team Repository Permissions", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/repos/:owner/:repo", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Conten" }, { "info": { "name": "GitHub Remove a Repository from a Team", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/repos/:owner/:repo", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}" }, { "info": { "name": "GitHub List Child Teams", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/teams", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`." }, { "info": { "name": "GitHub Get a Team (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#get-a-team-by-name) endpoint." }, { "info": { "name": "GitHub Update a Team (Legacy)", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/teams/:team_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`." }, { "info": { "name": "GitHub Delete a Team (Legacy)", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/teams/:team_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well." }, { "info": { "name": "GitHub List Discussions (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Discussion (Legacy)", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creati" }, { "info": { "name": "GitHub Get a Discussion (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Update a Discussion (Legacy)", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Discussion (Legacy)", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub List Discussion Comments (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number/comments", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "direction", "value": "", "type": "query", "description": "The direction to sort the results by." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Discussion Comment (Legacy)", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number/comments", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-noti" }, { "info": { "name": "GitHub Get a Discussion Comment (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number/comments/:comment_number", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Update a Discussion Comment (Legacy)", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number/comments/:comment_number", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Discussion Comment (Legacy)", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number/comments/:comment_number", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub List Team Members (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/members", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "role", "value": "member", "type": "query", "description": "Filters members returned by their role in the team." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.9/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams." }, { "info": { "name": "GitHub Get Team Member (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/members/:username", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user." }, { "info": { "name": "GitHub Add Team Member (Legacy)", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/members/:username", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/gith" }, { "info": { "name": "GitHub Remove Team Member (Legacy)", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/members/:username", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-sta" }, { "info": { "name": "GitHub Get Team Membership for a User (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/memberships/:username", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membe" }, { "info": { "name": "GitHub Add or Update Team Membership for a User (Legacy)", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/memberships/:username", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/ge" }, { "info": { "name": "GitHub Remove Team Membership for a User (Legacy)", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/memberships/:username", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-" }, { "info": { "name": "GitHub List Team Projects (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/projects", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team." }, { "info": { "name": "GitHub Check Team Permissions for a Project (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/projects/:project_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team." }, { "info": { "name": "GitHub Add or Update Team Project Permissions (Legacy)", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/projects/:project_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The pro" }, { "info": { "name": "GitHub Remove a Project from a Team (Legacy)", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/projects/:project_id", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user mu" }, { "info": { "name": "GitHub List Team Repositories (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/repos", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-repositories) endpoint." }, { "info": { "name": "GitHub Check Team Permissions for a Repository (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/repos/:owner/:repo", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it," }, { "info": { "name": "GitHub Add or Update Team Repository Permissions (Legacy)", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/repos/:owner/:repo", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The " }, { "info": { "name": "GitHub Remove a Repository from a Team (Legacy)", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/repos/:owner/:repo", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated use" }, { "info": { "name": "GitHub List Child Teams (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/teams", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-child-teams) endpoint." }, { "info": { "name": "GitHub List Teams for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/teams", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization." } ] }, { "info": { "name": "Migrations", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Organization Migrations", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "exclude", "value": "", "type": "query", "description": "Exclude attributes from the API response to improve performance" } ] }, "docs": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).\n\nA list of `repositories` is only returned for export migrations." }, { "info": { "name": "GitHub Start an Organization Migration", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the generation of a migration archive.\n\nBefore you can use this endpoint, you must configure a blob storage provider in the \"Migrations\" section in the Management Console. For more details, see \"[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.9/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enter" }, { "info": { "name": "GitHub Get an Organization Migration Status", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." }, { "name": "exclude", "value": "", "type": "query", "description": "Exclude attributes from the API response to improve performance" } ] }, "docs": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed." }, { "info": { "name": "GitHub Download an Organization Migration Archive", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id/archive", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." } ] }, "docs": "Fetches the URL to a migration archive." }, { "info": { "name": "GitHub Delete an Organization Migration Archive", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id/archive", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." } ] }, "docs": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days." }, { "info": { "name": "GitHub Unlock an Organization Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id/repos/:repo_name/lock", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." }, { "name": "repo_name", "value": "", "type": "path", "description": "repo_name parameter" } ] }, "docs": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data." }, { "info": { "name": "GitHub List Repositories in an Organization Migration", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/migrations/:migration_id/repositories", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List all the repositories for this organization migration." }, { "info": { "name": "GitHub List User Migrations", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/migrations", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all migrations a user has started." }, { "info": { "name": "GitHub Start a User Migration", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/migrations", "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the generation of a user migration archive." }, { "info": { "name": "GitHub Download a User Migration Archive", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/migrations/:migration_id/archive", "params": [ { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." } ] }, "docs": "Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:\n\n* attachments\n* bases\n* commit\\_comments\n* issue\\_comments\n* issue\\_events\n* issues\n* milestones\n* organizations\n* projects\n* protected\\_branches\n* pull\\_request\\_reviews\n* pull\\_requests\n* releases\n* repositories\n* review\\_comments\n* schema\n* users\n\nThe archive will also" }, { "info": { "name": "GitHub List Repositories for a User Migration", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/migrations/:migration_id/repositories", "params": [ { "name": "migration_id", "value": "", "type": "path", "description": "The unique identifier of the migration." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all the repositories for this user migration." } ] }, { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Organization Projects", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/projects", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the projects to return." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub Create an Organization Project", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/projects", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub Get a Project Card", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/columns/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ] }, "docs": "Gets information about a project card." }, { "info": { "name": "GitHub Update an Existing Project Card", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/projects/columns/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Update an Existing Project Card" }, { "info": { "name": "GitHub Delete a Project Card", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/projects/columns/cards/:card_id", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ] }, "docs": "Deletes a project card" }, { "info": { "name": "GitHub Move a Project Card", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/projects/columns/cards/:card_id/moves", "params": [ { "name": "card_id", "value": "", "type": "path", "description": "The unique identifier of the card." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Move a Project Card" }, { "info": { "name": "GitHub Get a Project Column", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ] }, "docs": "Gets information about a project column." }, { "info": { "name": "GitHub Update an Existing Project Column", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Update an Existing Project Column" }, { "info": { "name": "GitHub Delete a Project Column", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ] }, "docs": "Deletes a project column." }, { "info": { "name": "GitHub List Project Cards", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id/cards", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." }, { "name": "archived_state", "value": "all", "type": "query", "description": "Filters the project cards that are returned by the card's state." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the project cards in a project." }, { "info": { "name": "GitHub Create a Project Card", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id/cards", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Create a Project Card" }, { "info": { "name": "GitHub Move a Project Column", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/projects/columns/:column_id/moves", "params": [ { "name": "column_id", "value": "", "type": "path", "description": "The unique identifier of the column." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Move a Project Column" }, { "info": { "name": "GitHub Get a Project", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub Update a Project", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub Delete a Project", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ] }, "docs": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled." }, { "info": { "name": "GitHub List Project Collaborators", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/collaborators", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "affiliation", "value": "outside", "type": "query", "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators." }, { "info": { "name": "GitHub Add Project Collaborator", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/collaborators/:username", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator." }, { "info": { "name": "GitHub Remove User as a Collaborator", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/collaborators/:username", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator." }, { "info": { "name": "GitHub Get Project Permission for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/collaborators/:username/permission", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level." }, { "info": { "name": "GitHub List Project Columns", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/columns", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the project columns in a project." }, { "info": { "name": "GitHub Create a Project Column", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/projects/:project_id/columns", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The unique identifier of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new project column." }, { "info": { "name": "GitHub List Repository Projects", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/projects", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the projects to return." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub Create a Repository Project", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/projects", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub Create a User Project", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/projects", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned." }, { "info": { "name": "GitHub List User Projects", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/projects", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "state", "value": "open", "type": "query", "description": "Indicates the state of the projects to return." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists projects for a user." } ] }, { "info": { "name": "Repos", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Organization Repositories", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/repos", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "type", "value": "all", "type": "query", "description": "Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation access token." }, { "name": "sort", "value": "created", "type": "query", "description": "The property to sort the results by." }, { "name": "direction", "value": "asc", "type": "query", "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organizati" }, { "info": { "name": "GitHub Create an Organization Repository", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/repos", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository." }, { "info": { "name": "GitHub Get a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/en" }, { "info": { "name": "GitHub Update a Repository", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#replace-all-repository-topics) endpoint." }, { "info": { "name": "GitHub Delete a Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Deleting a repository requires admin access.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.\n\nOAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get All Autolinks of a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/autolinks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets all autolinks that are configured for a repository.\n\nInformation about autolinks are only available to repository administrators." }, { "info": { "name": "GitHub Create an Autolink Reference for a Repository", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/autolinks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Users with admin access to the repository can create an autolink." }, { "info": { "name": "GitHub Get an Autolink Reference of a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/autolinks/:autolink_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "autolink_id", "value": "", "type": "path", "description": "The unique identifier of the autolink." } ] }, "docs": "This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators." }, { "info": { "name": "GitHub Delete an Autolink Reference from a Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/autolinks/:autolink_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "autolink_id", "value": "", "type": "path", "description": "The unique identifier of the autolink." } ] }, "docs": "This deletes a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators." }, { "info": { "name": "GitHub List Branches", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "protected", "value": "true", "type": "query", "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Branches" }, { "info": { "name": "GitHub Get a Branch", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "GitHub Get a Branch" }, { "info": { "name": "GitHub Get Branch Protection", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Update Branch Protection", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Pa" }, { "info": { "name": "GitHub Delete Branch Protection", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Get Admin Branch Protection", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/enforce_admins", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Set Admin Branch Protection", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/enforce_admins", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branc" }, { "info": { "name": "GitHub Delete Admin Branch Protection", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/enforce_admins", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and bra" }, { "info": { "name": "GitHub Get Pull Request Review Protection", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Update Pull Request Review Protection", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repo" }, { "info": { "name": "GitHub Delete Pull Request Review Protection", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Get Commit Signature Protection", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_signatures", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this e" }, { "info": { "name": "GitHub Create Commit Signature Protection", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_signatures", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this e" }, { "info": { "name": "GitHub Delete Commit Signature Protection", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_signatures", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this e" }, { "info": { "name": "GitHub Get Status Checks Protection", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Update Status Check Protection", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository an" }, { "info": { "name": "GitHub Remove Status Check Protection", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Get All Status Check Contexts", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Add Status Check Contexts", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Set Status Check Contexts", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Remove Status Check Contexts", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation." }, { "info": { "name": "GitHub Get Access Restrictions", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restri" }, { "info": { "name": "GitHub Delete Access Restrictions", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch." }, { "info": { "name": "GitHub Get Apps with Access to the Protected Branch", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/apps", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are in" }, { "info": { "name": "GitHub Add App Access Restrictions", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/apps", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are install" }, { "info": { "name": "GitHub Set App Access Restrictions", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/apps", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps th" }, { "info": { "name": "GitHub Remove App Access Restrictions", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/apps", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installe" }, { "info": { "name": "GitHub Get Teams with Access to the Protected Branch", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/teams", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams." }, { "info": { "name": "GitHub Add Team Access Restrictions", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/teams", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to" }, { "info": { "name": "GitHub Set Team Access Restrictions", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/teams", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams " }, { "info": { "name": "GitHub Remove Team Access Restrictions", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/teams", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access fo" }, { "info": { "name": "GitHub Get Users with Access to the Protected Branch", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/users", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch." }, { "info": { "name": "GitHub Add User Access Restrictions", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/users", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description " }, { "info": { "name": "GitHub Set User Access Restrictions", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/users", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all peopl" }, { "info": { "name": "GitHub Remove User Access Restrictions", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/users", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description " }, { "info": { "name": "GitHub Rename a Branch", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/rename", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default bran" }, { "info": { "name": "GitHub List CODEOWNERS Errors", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/codeowners/errors", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "main", "type": "query", "description": "A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`)" } ] }, "docs": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"" }, { "info": { "name": "GitHub List Repository Collaborators", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/collaborators", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "affiliation", "value": "outside", "type": "query", "description": "Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see." }, { "name": "permission", "value": "pull", "type": "query", "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nOrganization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.\n\nTeam members will include the members of child teams.\n\nThe authenticat" }, { "info": { "name": "GitHub Check if a User is a Repository Collaborator", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/collaborators/:username", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic" }, { "info": { "name": "GitHub Add a Repository Collaborator", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/collaborators/:username", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterp" }, { "info": { "name": "GitHub Remove a Repository Collaborator", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/collaborators/:username", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user " }, { "info": { "name": "GitHub Get Repository Permissions for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/collaborators/:username/permission", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can" }, { "info": { "name": "GitHub List Commit Comments for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`appl" }, { "info": { "name": "GitHub Get a Commit Comment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/comments/:comment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ] }, "docs": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a te" }, { "info": { "name": "GitHub Update a Commit Comment", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/comments/:comment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+js" }, { "info": { "name": "GitHub Delete a Commit Comment", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/comments/:comment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ] }, "docs": "GitHub Delete a Commit Comment" }, { "info": { "name": "GitHub List Commits", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "sha", "value": "abc123def456789012345678901234567890", "type": "query", "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`)." }, { "name": "path", "value": "src/index.js", "type": "query", "description": "Only commits containing this file path will be returned." }, { "name": "author", "value": "example_value", "type": "query", "description": "GitHub username or email address to use to filter by commit author." }, { "name": "committer", "value": "example_value", "type": "query", "description": "GitHub username or email address to use to filter by commit committer." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "until", "value": "example_value", "type": "query", "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| - | - | -- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signatu" }, { "info": { "name": "GitHub List Branches for HEAD Commit", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits/:commit_sha/branches-where-head", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "commit_sha", "value": "", "type": "path", "description": "The SHA of the commit." } ] }, "docs": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the br" }, { "info": { "name": "GitHub List Commit Comments", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits/:commit_sha/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "commit_sha", "value": "", "type": "path", "description": "The SHA of the commit." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Re" }, { "info": { "name": "GitHub Create a Commit Comment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits/:commit_sha/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "commit_sha", "value": "", "type": "path", "description": "The SHA of the commit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practice" }, { "info": { "name": "GitHub List Pull Requests Associated with a Commit", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits/:commit_sha/pulls", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "commit_sha", "value": "", "type": "path", "description": "The SHA of the commit." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.\n\nTo list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name." }, { "info": { "name": "GitHub Get a Commit", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits/:ref", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "ref", "value": "", "type": "path", "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." } ] }, "docs": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more info" }, { "info": { "name": "GitHub Get the Combined Status for a Specific Reference", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits/:ref/status", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "", "type": "path", "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`" }, { "info": { "name": "GitHub List Commit Statuses for a Reference", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits/:ref/statuses", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "", "type": "path", "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`." }, { "info": { "name": "GitHub Compare Two Commits", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/compare/:basehead", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "basehead", "value": "example_value", "type": "path", "description": "The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`." } ] }, "docs": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.9/repositories/viewing-activity-and-data-for-your-repository/understanding-conn" }, { "info": { "name": "GitHub Get Repository Content", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/contents/:path", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "path", "value": "src/index.js", "type": "path", "description": "path parameter" }, { "name": "ref", "value": "main", "type": "query", "description": "The name of the commit/branch/tag. Default: the repository’s default branch." } ] }, "docs": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file" }, { "info": { "name": "GitHub Create or Update File Contents", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/contents/:path", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "path", "value": "src/index.js", "type": "path", "description": "path parameter" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new file or replaces an existing file in a repository.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify" }, { "info": { "name": "GitHub Delete a File", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/contents/:path", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "path", "value": "src/index.js", "type": "path", "description": "path parameter" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether y" }, { "info": { "name": "GitHub List Repository Contributors", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/contributors", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "anon", "value": "example_value", "type": "query", "description": "Set to `1` or `true` to include anonymous contributors in results." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repos" }, { "info": { "name": "GitHub List Deployments", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/deployments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "sha", "value": "abc123def456789012345678901234567890", "type": "query", "description": "The SHA recorded at creation time." }, { "name": "ref", "value": "main", "type": "query", "description": "The name of the ref. This can be a branch, tag, or SHA." }, { "name": "task", "value": "example_value", "type": "query", "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`)." }, { "name": "environment", "value": "example_value", "type": "query", "description": "The name of the environment that was deployed to (e.g., `staging` or `production`)." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Simple filtering of deployments is available via query parameters:" }, { "info": { "name": "GitHub Create a Deployment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/deployments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environment" }, { "info": { "name": "GitHub Get a Deployment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/deployments/:deployment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "deployment_id", "value": "", "type": "path", "description": "deployment_id parameter" } ] }, "docs": "GitHub Get a Deployment" }, { "info": { "name": "GitHub Delete a Deployment", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/deployments/:deployment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "deployment_id", "value": "", "type": "path", "description": "deployment_id parameter" } ] }, "docs": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deploym" }, { "info": { "name": "GitHub List Deployment Statuses", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/deployments/:deployment_id/statuses", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "deployment_id", "value": "", "type": "path", "description": "deployment_id parameter" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Users with pull access can view deployment statuses for a deployment:" }, { "info": { "name": "GitHub Create a Deployment Status", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/deployments/:deployment_id/statuses", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "deployment_id", "value": "", "type": "path", "description": "deployment_id parameter" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Users with `push` access can create deployment statuses for a given deployment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Deployment Status", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "deployment_id", "value": "", "type": "path", "description": "deployment_id parameter" }, { "name": "status_id", "value": "42", "type": "path" } ] }, "docs": "Users with pull access can view a deployment status for a deployment:" }, { "info": { "name": "GitHub Create a Repository Dispatch Event", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dispatches", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#repository_dispa" }, { "info": { "name": "GitHub List Environments", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the environments for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Get an Environment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." } ] }, "docs": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Create or Update an Environment", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/" }, { "info": { "name": "GitHub Delete an Environment", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." } ] }, "docs": "OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Deployment Branch Policies", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/deployment-branch-policies", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the deployment branch policies for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Create a Deployment Branch Policy", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/deployment-branch-policies", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Deployment Branch Policy", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/deployment-branch-policies/:branch_policy_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." }, { "name": "branch_policy_id", "value": "", "type": "path", "description": "The unique identifier of the branch policy." } ] }, "docs": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Update a Deployment Branch Policy", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/deployment-branch-policies/:branch_policy_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." }, { "name": "branch_policy_id", "value": "", "type": "path", "description": "The unique identifier of the branch policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Deployment Branch Policy", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/environments/:environment_name/deployment-branch-policies/:branch_policy_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "environment_name", "value": "", "type": "path", "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`." }, { "name": "branch_policy_id", "value": "", "type": "path", "description": "The unique identifier of the branch policy." } ] }, "docs": "Deletes a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Forks", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/forks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "sort", "value": "newest", "type": "query", "description": "The sort order. `stargazers` will sort by star count." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Forks" }, { "info": { "name": "GitHub Create a Fork", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/forks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n**Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source ac" }, { "info": { "name": "GitHub List Repository Webhooks", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days." }, { "info": { "name": "GitHub Create a Repository Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap." }, { "info": { "name": "GitHub Get a Repository Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).\"" }, { "info": { "name": "GitHub Update a Repository Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).\"" }, { "info": { "name": "GitHub Delete a Repository Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "GitHub Delete a Repository Webhook" }, { "info": { "name": "GitHub Get a Webhook Configuration for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id/config", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Update a Webhook Configuration for a Repository", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id/config", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List Deliveries for a Repository Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id/deliveries", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "cursor", "value": "", "type": "query", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors." }, { "name": "redelivery", "value": "true", "type": "query" } ] }, "docs": "Returns a list of webhook deliveries for a webhook configured in a repository." }, { "info": { "name": "GitHub Get a Delivery for a Repository Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id/deliveries/:delivery_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." }, { "name": "delivery_id", "value": "", "type": "path" } ] }, "docs": "Returns a delivery for a webhook configured in a repository." }, { "info": { "name": "GitHub Redeliver a Delivery for a Repository Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id/deliveries/:delivery_id/attempts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." }, { "name": "delivery_id", "value": "", "type": "path" } ] }, "docs": "Redeliver a webhook delivery for a webhook configured in a repository." }, { "info": { "name": "GitHub Ping a Repository Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id/pings", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the hook." }, { "info": { "name": "GitHub Test the Push Repository Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/hooks/:hook_id/tests", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "hook_id", "value": "", "type": "path", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery." } ] }, "docs": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`" }, { "info": { "name": "GitHub List Repository Invitations", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/invitations", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations." }, { "info": { "name": "GitHub Update a Repository Invitation", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/invitations/:invitation_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "invitation_id", "value": "", "type": "path", "description": "The unique identifier of the invitation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Update a Repository Invitation" }, { "info": { "name": "GitHub Delete a Repository Invitation", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/invitations/:invitation_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "invitation_id", "value": "", "type": "path", "description": "The unique identifier of the invitation." } ] }, "docs": "GitHub Delete a Repository Invitation" }, { "info": { "name": "GitHub List Deploy Keys", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/keys", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Deploy Keys" }, { "info": { "name": "GitHub Create a Deploy Key", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/keys", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can create a read-only deploy key." }, { "info": { "name": "GitHub Get a Deploy Key", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/keys/:key_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "key_id", "value": "", "type": "path", "description": "The unique identifier of the key." } ] }, "docs": "GitHub Get a Deploy Key" }, { "info": { "name": "GitHub Delete a Deploy Key", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/keys/:key_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "key_id", "value": "", "type": "path", "description": "The unique identifier of the key." } ] }, "docs": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead." }, { "info": { "name": "GitHub List Repository Languages", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/languages", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language." }, { "info": { "name": "GitHub Enable Git LFS for a Repository", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/lfs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Enables Git LFS for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Disable Git LFS for a Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/lfs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Disables Git LFS for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint." }, { "info": { "name": "GitHub Sync a Fork Branch with the Upstream Repository", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/merge-upstream", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository." }, { "info": { "name": "GitHub Merge a Branch", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/merges", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Merge a Branch" }, { "info": { "name": "GitHub Get a GitHub Enterprise Server Pages Site", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets information about a GitHub Enterprise Server Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create a GitHub Enterprise Server Pages Site", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Update Information About a GitHub Enterprise Server Pages Site", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a GitHub Enterprise Server Pages Site", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Deletes a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub List GitHub Enterprise Server Pages Builds", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages/builds", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists builts of a GitHub Enterprise Server Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Request a GitHub Enterprise Server Pages Build", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages/builds", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until th" }, { "info": { "name": "GitHub Get Latest Pages Build", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages/builds/latest", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Gets information about the single most recent build of a GitHub Enterprise Server Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Get GitHub Enterprise Server Pages Build", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages/builds/:build_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "build_id", "value": "42", "type": "path" } ] }, "docs": "Gets information about a GitHub Enterprise Server Pages build.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." }, { "info": { "name": "GitHub Create a GitHub Pages Deployment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pages/deployments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a GitHub Pages deployment for a repository.\n\nThe authenticated user must have write permission to the repository." }, { "info": { "name": "GitHub Get a Repository README", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/readme", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "main", "type": "query", "description": "The name of the commit/branch/tag. Default: the repository’s default branch." } ] }, "docs": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML u" }, { "info": { "name": "GitHub Get a Repository README for a Directory", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/readme/:dir", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "dir", "value": "example_value", "type": "path", "description": "The alternate path to look for a README file" }, { "name": "ref", "value": "main", "type": "query", "description": "The name of the commit/branch/tag. Default: the repository’s default branch." } ] }, "docs": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML " }, { "info": { "name": "GitHub List Releases", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases." }, { "info": { "name": "GitHub Create a Release", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best " }, { "info": { "name": "GitHub Get a Release Asset", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/assets/:asset_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "asset_id", "value": "", "type": "path", "description": "The unique identifier of the asset." } ] }, "docs": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response." }, { "info": { "name": "GitHub Update a Release Asset", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/assets/:asset_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "asset_id", "value": "", "type": "path", "description": "The unique identifier of the asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Users with push access to the repository can edit a release asset." }, { "info": { "name": "GitHub Delete a Release Asset", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/assets/:asset_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "asset_id", "value": "", "type": "path", "description": "The unique identifier of the asset." } ] }, "docs": "GitHub Delete a Release Asset" }, { "info": { "name": "GitHub Generate Release Notes Content for a Release", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/generate-notes", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release." }, { "info": { "name": "GitHub Get the Latest Release", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/latest", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published." }, { "info": { "name": "GitHub Get a Release by Tag Name", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/tags/:tag", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "tag", "value": "example_value", "type": "path", "description": "tag parameter" } ] }, "docs": "Get a published release with the specified tag." }, { "info": { "name": "GitHub Get a Release", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/:release_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of the release." } ] }, "docs": "Gets a public release with the specified release ID.\n\n**Note:** This returns an `upload_url` key corresponding to the endpoint\nfor uploading release assets. This key is a hypermedia resource. For more information, see\n\"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"" }, { "info": { "name": "GitHub Update a Release", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/:release_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of the release." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Users with push access to the repository can edit a release." }, { "info": { "name": "GitHub Delete a Release", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/:release_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of the release." } ] }, "docs": "Users with push access to the repository can delete a release." }, { "info": { "name": "GitHub List Release Assets", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/:release_id/assets", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of the release." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Release Assets" }, { "info": { "name": "GitHub Upload a Release Asset", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/:release_id/assets", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of the release." }, { "name": "name", "value": "octocat", "type": "query" }, { "name": "label", "value": "Example Title", "type": "query" } ] }, "docs": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP cli" }, { "info": { "name": "GitHub List Repository Cache Replication Status", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/replicas/caches", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the status of each repository cache replica." }, { "info": { "name": "GitHub Get the Weekly Commit Activity", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/stats/code_frequency", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository." }, { "info": { "name": "GitHub Get the Last Year of Commit Activity", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/stats/commit_activity", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`." }, { "info": { "name": "GitHub Get All Contributor Commit Activity", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/stats/contributors", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits" }, { "info": { "name": "GitHub Get the Weekly Commit Count", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/stats/participation", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.\n\nThe most recent week is seven days ago at UTC midnight to today at UTC midnight." }, { "info": { "name": "GitHub Get the Hourly Commit Count for Each Day", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/stats/punch_card", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits." }, { "info": { "name": "GitHub Create a Commit Status", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/statuses/:sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "sha", "value": "abc123def456789012345678901234567890", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error." }, { "info": { "name": "GitHub List Repository Tags", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/tags", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub List Repository Tags" }, { "info": { "name": "GitHub List Tag Protection States for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/tags/protection", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "This returns the tag protection states of a repository.\n\nThis information is only available to repository administrators." }, { "info": { "name": "GitHub Create a Tag Protection State for a Repository", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/tags/protection", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators." }, { "info": { "name": "GitHub Delete a Tag Protection State for a Repository", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/tags/protection/:tag_protection_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "tag_protection_id", "value": "", "type": "path", "description": "The unique identifier of the tag protection." } ] }, "docs": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators." }, { "info": { "name": "GitHub Download a Repository Archive (tar)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/tarball/:ref", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "main", "type": "path" } ] }, "docs": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes." }, { "info": { "name": "GitHub List Repository Teams", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/teams", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the teams that have access to the specified repository and that are also visible to the authenticated user.\n\nFor a public repository, a team is listed only if that team added the public repository explicitly.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository." }, { "info": { "name": "GitHub Get All Repository Topics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/topics", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "GitHub Get All Repository Topics" }, { "info": { "name": "GitHub Replace All Repository Topics", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/topics", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Replace All Repository Topics" }, { "info": { "name": "GitHub Transfer a Repository", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/transfer", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.9/articles/about-repository-transfers/).\nYou must use a personal access token or an OAuth token for this endpoint. " }, { "info": { "name": "GitHub Check if Vulnerability Alerts Are Enabled for a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/vulnerability-alerts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)\"." }, { "info": { "name": "GitHub Enable Vulnerability Alerts", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/vulnerability-alerts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)\"." }, { "info": { "name": "GitHub Disable Vulnerability Alerts", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/vulnerability-alerts", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)\"." }, { "info": { "name": "GitHub Download a Repository Archive (zip)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/zipball/:ref", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "main", "type": "path" } ] }, "docs": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect." }, { "info": { "name": "GitHub Create a Repository Using a Template", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:template_owner/:template_repo/generate", "params": [ { "name": "template_owner", "value": "example_value", "type": "path", "description": "The account owner of the template repository. The name is not case sensitive." }, { "name": "template_repo", "value": "example_value", "type": "path", "description": "The name of the template repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-a-repository) endpoi" }, { "info": { "name": "GitHub List Public Repositories", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repositories", "params": [ { "name": "since", "value": "", "type": "query", "description": "A repository ID. Only return repositories with an ID greater than this ID." }, { "name": "visibility", "value": "all", "type": "query", "description": "Specifies the types of repositories to return. This endpoint will only list repositories available to all users on the enterprise." } ] }, "docs": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories." }, { "info": { "name": "GitHub List Repositories for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/repos", "params": [ { "name": "visibility", "value": "all", "type": "query", "description": "Limit results to repositories with the specified visibility." }, { "name": "affiliation", "value": "example_value", "type": "query", "description": "Comma-separated list of values. Can include: \n * `owner`: Repositories that are owned by the authenticated user. \n * `collaborator`: Repositories that the user has been added to as a collaborator. \n * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on." }, { "name": "type", "value": "all", "type": "query", "description": "Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**." }, { "name": "sort", "value": "created", "type": "query", "description": "The property to sort the results by." }, { "name": "direction", "value": "asc", "type": "query", "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "since", "value": "", "type": "query", "description": "Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "before", "value": "", "type": "query", "description": "Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." } ] }, "docs": "Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership." }, { "info": { "name": "GitHub Create a Repository for the Authenticated User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/repos", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new repository for the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository." }, { "info": { "name": "GitHub List Repository Invitations for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/repository_invitations", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user." }, { "info": { "name": "GitHub Accept a Repository Invitation", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/user/repository_invitations/:invitation_id", "params": [ { "name": "invitation_id", "value": "", "type": "path", "description": "The unique identifier of the invitation." } ] }, "docs": "GitHub Accept a Repository Invitation" }, { "info": { "name": "GitHub Decline a Repository Invitation", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/repository_invitations/:invitation_id", "params": [ { "name": "invitation_id", "value": "", "type": "path", "description": "The unique identifier of the invitation." } ] }, "docs": "GitHub Decline a Repository Invitation" }, { "info": { "name": "GitHub List Repositories for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/repos", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "type", "value": "all", "type": "query", "description": "Limit results to repositories of the specified type." }, { "name": "sort", "value": "created", "type": "query", "description": "The property to sort the results by." }, { "name": "direction", "value": "asc", "type": "query", "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists public repositories for the specified user." } ] }, { "info": { "name": "Reactions", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Reactions for a Team Discussion Comment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." }, { "name": "content", "value": "+1", "type": "query", "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Create Reaction for a Team Discussion Comment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access" }, { "info": { "name": "GitHub Delete Team Discussion Comment Reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." }, { "name": "reaction_id", "value": "", "type": "path", "description": "The unique identifier of the reaction." } ] }, "docs": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub List Reactions for a Team Discussion", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "content", "value": "+1", "type": "query", "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub Create Reaction for a Team Discussion", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to us" }, { "info": { "name": "GitHub Delete Team Discussion Reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." }, { "name": "team_slug", "value": "", "type": "path", "description": "The slug of the team name." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "reaction_id", "value": "", "type": "path", "description": "The unique identifier of the reaction." } ] }, "docs": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint." }, { "info": { "name": "GitHub List Reactions for a Commit Comment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/comments/:comment_id/reactions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." }, { "name": "content", "value": "+1", "type": "query", "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment)." }, { "info": { "name": "GitHub Create Reaction for a Commit Comment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/comments/:comment_id/reactions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment." }, { "info": { "name": "GitHub Delete a Commit Comment Reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." }, { "name": "reaction_id", "value": "", "type": "path", "description": "The unique identifier of the reaction." } ] }, "docs": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment)." }, { "info": { "name": "GitHub List Reactions for an Issue Comment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/comments/:comment_id/reactions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." }, { "name": "content", "value": "+1", "type": "query", "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment)." }, { "info": { "name": "GitHub Create Reaction for an Issue Comment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/comments/:comment_id/reactions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment." }, { "info": { "name": "GitHub Delete an Issue Comment Reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." }, { "name": "reaction_id", "value": "", "type": "path", "description": "The unique identifier of the reaction." } ] }, "docs": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment)." }, { "info": { "name": "GitHub List Reactions for an Issue", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/reactions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." }, { "name": "content", "value": "+1", "type": "query", "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List the reactions to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue)." }, { "info": { "name": "GitHub Create Reaction for an Issue", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/reactions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue." }, { "info": { "name": "GitHub Delete an Issue Reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "issue_number", "value": "", "type": "path", "description": "The number that identifies the issue." }, { "name": "reaction_id", "value": "", "type": "path", "description": "The unique identifier of the reaction." } ] }, "docs": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue)." }, { "info": { "name": "GitHub List Reactions for a Pull Request Review Comment", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/comments/:comment_id/reactions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." }, { "name": "content", "value": "+1", "type": "query", "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request)." }, { "info": { "name": "GitHub Create Reaction for a Pull Request Review Comment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/comments/:comment_id/reactions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment." }, { "info": { "name": "GitHub Delete a Pull Request Comment Reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." }, { "name": "reaction_id", "value": "", "type": "path", "description": "The unique identifier of the reaction." } ] }, "docs": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request)." }, { "info": { "name": "GitHub List Reactions for a Release", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/:release_id/reactions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of the release." }, { "name": "content", "value": "+1", "type": "query", "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "List the reactions to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release)." }, { "info": { "name": "GitHub Create Reaction for a Release", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/:release_id/reactions", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of the release." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release." }, { "info": { "name": "GitHub Delete a Release Reaction", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/releases/:release_id/reactions/:reaction_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "release_id", "value": "", "type": "path", "description": "The unique identifier of the release." }, { "name": "reaction_id", "value": "", "type": "path", "description": "The unique identifier of the reaction." } ] }, "docs": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release)." }, { "info": { "name": "GitHub List Reactions for a Team Discussion Comment (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." }, { "name": "content", "value": "+1", "type": "query", "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tok" }, { "info": { "name": "GitHub Create Reaction for a Team Discussion Comment (Legacy)", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "comment_number", "value": "", "type": "path", "description": "The number that identifies the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response w" }, { "info": { "name": "GitHub List Reactions for a Team Discussion (Legacy)", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number/reactions", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." }, { "name": "content", "value": "+1", "type": "query", "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic)" }, { "info": { "name": "GitHub Create Reaction for a Team Discussion (Legacy)", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/teams/:team_id/discussions/:discussion_number/reactions", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The unique identifier of the team." }, { "name": "discussion_number", "value": "", "type": "path", "description": "The number that identifies the discussion." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you " } ] }, { "info": { "name": "Rate-Limit", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get Rate Limit Status for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/rate_limit" }, "docs": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate lim" } ] }, { "info": { "name": "Checks", "type": "folder" }, "items": [ { "info": { "name": "GitHub Create a Check Run", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/check-runs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new check run for a specific commit in a repository.\n\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.\n\n**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branc" }, { "info": { "name": "GitHub Get a Check Run", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/check-runs/:check_run_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "check_run_id", "value": "", "type": "path", "description": "The unique identifier of the check run." } ] }, "docs": "Gets a single check run using its `id`.\n\n**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository." }, { "info": { "name": "GitHub Update a Check Run", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/check-runs/:check_run_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "check_run_id", "value": "", "type": "path", "description": "The unique identifier of the check run." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a check run for a specific commit in a repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint." }, { "info": { "name": "GitHub List Check Run Annotations", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/check-runs/:check_run_id/annotations", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "check_run_id", "value": "", "type": "path", "description": "The unique identifier of the check run." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists annotations for a check run using the annotation `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository." }, { "info": { "name": "GitHub Rerequest a Check Run", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/check-runs/:check_run_id/rerequest", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "check_run_id", "value": "", "type": "path", "description": "The unique identifier of the check run." } ] }, "docs": "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/enterprise-server@3.9/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\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enter" }, { "info": { "name": "GitHub Create a Check Suite", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/check-suites", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n**Note:** The Checks API only looks for " }, { "info": { "name": "GitHub Update Repository Preferences for Check Suites", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/check-suites/preferences", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites." }, { "info": { "name": "GitHub Get a Check Suite", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/check-suites/:check_suite_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "check_suite_id", "value": "", "type": "path", "description": "The unique identifier of the check suite." } ] }, "docs": "Gets a single check suite using its `id`.\n\n**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository." }, { "info": { "name": "GitHub List Check Runs in a Check Suite", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/check-suites/:check_suite_id/check-runs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "check_suite_id", "value": "", "type": "path", "description": "The unique identifier of the check suite." }, { "name": "check_name", "value": "", "type": "query", "description": "Returns check runs with the specified `name`." }, { "name": "status", "value": "", "type": "query", "description": "Returns check runs with the specified `status`." }, { "name": "filter", "value": "latest", "type": "query", "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists check runs for a check suite using its `id`.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository." }, { "info": { "name": "GitHub Rerequest a Check Suite", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/check-suites/:check_suite_id/rerequest", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "check_suite_id", "value": "", "type": "path", "description": "The unique identifier of the check suite." } ] }, "docs": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint." }, { "info": { "name": "GitHub List Check Runs for a Git Reference", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits/:ref/check-runs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "", "type": "path", "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." }, { "name": "check_name", "value": "", "type": "query", "description": "Returns check runs with the specified `name`." }, { "name": "status", "value": "", "type": "query", "description": "Returns check runs with the specified `status`." }, { "name": "filter", "value": "latest", "type": "query", "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "app_id", "value": "42", "type": "query" } ] }, "docs": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check run" }, { "info": { "name": "GitHub List Check Suites for a Git Reference", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/commits/:ref/check-suites", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "", "type": "path", "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." }, { "name": "app_id", "value": "1", "type": "query", "description": "Filters check suites by GitHub App `id`." }, { "name": "check_name", "value": "", "type": "query", "description": "Returns check runs with the specified `name`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository." } ] }, { "info": { "name": "Dependency-Graph", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get a Diff of the Dependencies Between Commits", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependency-graph/compare/:basehead", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "basehead", "value": "example_value", "type": "path", "description": "The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`." }, { "name": "name", "value": "", "type": "query", "description": "The full path, relative to the repository root, of the dependency manifest file." } ] }, "docs": "Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits." }, { "info": { "name": "GitHub Export a Software Bill of Materials (SBOM) for a Repository.", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependency-graph/sbom", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ] }, "docs": "Exports the software bill of materials (SBOM) for a repository in SPDX JSON format." }, { "info": { "name": "GitHub Create a Snapshot of Dependencies for a Repository", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/dependency-graph/snapshots", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new snapshot of a repository's dependencies.\n\nThe authenticated user must have access to the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint." } ] }, { "info": { "name": "Git", "type": "folder" }, "items": [ { "info": { "name": "GitHub Create a Blob", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/blobs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "GitHub Create a Blob" }, { "info": { "name": "GitHub Get a Blob", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/blobs/:file_sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "file_sha", "value": "abc123def456789012345678901234567890", "type": "path" } ] }, "docs": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no medi" }, { "info": { "name": "GitHub Create a Commit", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/commits", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| - | - | -- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for " }, { "info": { "name": "GitHub Get a Commit Object", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/commits/:commit_sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "commit_sha", "value": "", "type": "path", "description": "The SHA of the commit." } ] }, "docs": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| - | - | -- |\n| `verified` | `boolean` | Indicates whether GitHub considers t" }, { "info": { "name": "GitHub List Matching References", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/matching-refs/:ref", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "heads/feature-a", "type": "path", "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." } ] }, "docs": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anyt" }, { "info": { "name": "GitHub Get a Reference", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/ref/:ref", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "heads/feature-a", "type": "path", "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." } ] }, "docs": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability o" }, { "info": { "name": "GitHub Create a Reference", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/refs", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches." }, { "info": { "name": "GitHub Update a Reference", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/refs/:ref", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "heads/feature-a", "type": "path", "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." }, { "info": { "name": "GitHub Delete a Reference", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/refs/:ref", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "ref", "value": "heads/feature-a", "type": "path", "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." } ] }, "docs": "Deletes the provided reference." }, { "info": { "name": "GitHub Create a Tag Object", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/tags", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the tag reference - this call would b" }, { "info": { "name": "GitHub Get a Tag", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/tags/:tag_sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "tag_sha", "value": "abc123def456789012345678901234567890", "type": "path" } ] }, "docs": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| - | - | -- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signatu" }, { "info": { "name": "GitHub Create a Tree", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/trees", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@3.9/rest/git/commits#cre" }, { "info": { "name": "GitHub Get a Tree", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/git/trees/:tree_sha", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "tree_sha", "value": "abc123def456789012345678901234567890", "type": "path", "description": "The SHA1 value or ref (branch or tag) name of the tree." }, { "name": "recursive", "value": "example_value", "type": "query", "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees." } ] }, "docs": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter." } ] }, { "info": { "name": "Pulls", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Pull Requests", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "state", "value": "open", "type": "query", "description": "Either `open`, `closed`, or `all` to filter by state." }, { "name": "head", "value": "example_value", "type": "query", "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`." }, { "name": "base", "value": "example_value", "type": "query", "description": "Filter pulls by base branch name. Example: `gh-pages`." }, { "name": "sort", "value": "created", "type": "query", "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month." }, { "name": "direction", "value": "asc", "type": "query", "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports th" }, { "info": { "name": "GitHub Create a Pull Request", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have wr" }, { "info": { "name": "GitHub List Review Comments in a Repository", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "sort", "value": "created", "type": "query" }, { "name": "direction", "value": "asc", "type": "query", "description": "The direction to sort results. Ignored without `sort` parameter." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any spe" }, { "info": { "name": "GitHub Get a Review Comment for a Pull Request", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/comments/:comment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ] }, "docs": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`" }, { "info": { "name": "GitHub Update a Review Comment for a Pull Request", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/comments/:comment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`" }, { "info": { "name": "GitHub Delete a Review Comment for a Pull Request", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/comments/:comment_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ] }, "docs": "Deletes a review comment." }, { "info": { "name": "GitHub Get a Pull Request", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." } ] }, "docs": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [" }, { "info": { "name": "GitHub Update a Pull Request", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have wr" }, { "info": { "name": "GitHub List Review Comments on a Pull Request", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "sort", "value": "", "type": "query", "description": "The property to sort the results by." }, { "name": "direction", "value": "asc", "type": "query", "description": "The direction to sort results. Ignored without `sort` parameter." }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific" }, { "info": { "name": "GitHub Create a Review Comment for a Pull Request", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`," }, { "info": { "name": "GitHub Create a Reply for a Review Comment", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "comment_id", "value": "", "type": "path", "description": "The unique identifier of the comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate " }, { "info": { "name": "GitHub List Commits on a Pull Request", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/commits", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json" }, { "info": { "name": "GitHub List Pull Requests Files", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/files", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the files in a specified pull request.\n\n**Note:** Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default" }, { "info": { "name": "GitHub Check if a Pull Request Has Been Merged", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/merge", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." } ] }, "docs": "Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty." }, { "info": { "name": "GitHub Merge a Pull Request", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/merge", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using " }, { "info": { "name": "GitHub Get All Requested Reviewers for a Pull Request", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/requested_reviewers", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." } ] }, "docs": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#list-reviews-for-a-pull-request) operation." }, { "info": { "name": "GitHub Request Reviewers for a Pull Request", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/requested_reviewers", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"" }, { "info": { "name": "GitHub Remove Requested Reviewers from a Pull Request", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/requested_reviewers", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes review requests from a pull request for a given set of users and/or teams." }, { "info": { "name": "GitHub List Reviews for a Pull Request", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/reviews", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n-" }, { "info": { "name": "GitHub Create a Review for a Pull Request", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/reviews", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for usi" }, { "info": { "name": "GitHub Get a Review for a Pull Request", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "review_id", "value": "", "type": "path", "description": "The unique identifier of the review." } ] }, "docs": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Re" }, { "info": { "name": "GitHub Update a Review for a Pull Request", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "review_id", "value": "", "type": "path", "description": "The unique identifier of the review." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment" }, { "info": { "name": "GitHub Delete a Pending Review for a Pull Request", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "review_id", "value": "", "type": "path", "description": "The unique identifier of the review." } ] }, "docs": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`" }, { "info": { "name": "GitHub List Comments for a Pull Request Review", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "review_id", "value": "", "type": "path", "description": "The unique identifier of the review." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+jso" }, { "info": { "name": "GitHub Dismiss a Review for a Pull Request", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "review_id", "value": "", "type": "path", "description": "The unique identifier of the review." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Dismisses a specified review on a pull request.\n\n**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection),\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-star" }, { "info": { "name": "GitHub Submit a Review for a Pull Request", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." }, { "name": "review_id", "value": "", "type": "path", "description": "The unique identifier of the review." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/v" }, { "info": { "name": "GitHub Update a Pull Request Branch", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/pulls/:pull_number/update-branch", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "pull_number", "value": "", "type": "path", "description": "The number that identifies the pull request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch." } ] }, { "info": { "name": "Enterprise-Admin - Scim", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Provisioned SCIM Groups for an Enterprise", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups", "params": [ { "name": "filter", "value": "example_value", "type": "query", "description": "If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter=\"externalId eq '9138790-10932-109120392-12321'\"`." }, { "name": "excludedAttributes", "value": "", "type": "query", "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time." }, { "name": "startIndex", "value": "", "type": "query", "description": "Used for pagination: the starting index of the first result to return when paginating through values." }, { "name": "count", "value": "", "type": "query", "description": "Used for pagination: the number of results to return per page." } ] }, "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response." } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "GitHub Search Code", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/search/code", "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers." }, { "name": "sort", "value": "indexed", "type": "query", "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)" }, { "name": "order", "value": "desc", "type": "query", "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-ma" }, { "info": { "name": "GitHub Search Commits", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/search/commits", "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers." }, { "name": "sort", "value": "author-date", "type": "query", "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)" }, { "name": "order", "value": "", "type": "query", "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-server@3.9/rest/search/s" }, { "info": { "name": "GitHub Search Issues and Pull Requests", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/search/issues", "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers." }, { "name": "sort", "value": "comments", "type": "query", "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)" }, { "name": "order", "value": "", "type": "query", "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/sea" }, { "info": { "name": "GitHub Search Labels", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/search/labels", "params": [ { "name": "repository_id", "value": "42", "type": "query", "description": "The id of the repository." }, { "name": "q", "value": "example_value", "type": "query", "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query)." }, { "name": "sort", "value": "created", "type": "query", "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)" }, { "name": "order", "value": "", "type": "query", "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@" }, { "info": { "name": "GitHub Search Repositories", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/search/repositories", "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.9/articles/searching-for-repositories/)\" for a detailed list of qualifiers." }, { "name": "sort", "value": "stars", "type": "query", "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)" }, { "name": "order", "value": "", "type": "query", "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-mat" }, { "info": { "name": "GitHub Search Topics", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/search/topics", "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query)." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-server@3.9/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field wh" }, { "info": { "name": "GitHub Search Users", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/search/users", "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers." }, { "name": "sort", "value": "followers", "type": "query", "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)" }, { "name": "order", "value": "", "type": "query", "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metada" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user" }, "docs": "OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information." }, { "info": { "name": "GitHub Update the Authenticated User", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/user", "body": { "type": "json", "data": "{}" } }, "docs": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API." }, { "info": { "name": "GitHub List Email Addresses for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/emails", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all of your email addresses, and specifies which one is visible\nto the public.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint." }, { "info": { "name": "GitHub Add an Email Address for the Authenticated User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/emails", "body": { "type": "json", "data": "{}" } }, "docs": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint." }, { "info": { "name": "GitHub Delete an Email Address for the Authenticated User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/emails", "body": { "type": "json", "data": "{}" } }, "docs": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint." }, { "info": { "name": "GitHub List Followers of the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/followers", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the people following the authenticated user." }, { "info": { "name": "GitHub List the People the Authenticated User Follows", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/following", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the people who the authenticated user follows." }, { "info": { "name": "GitHub Check if a Person is Followed by the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/following/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "GitHub Check if a Person is Followed by the Authenticated User" }, { "info": { "name": "GitHub Follow a User", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/user/following/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint." }, { "info": { "name": "GitHub Unfollow a User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/following/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint." }, { "info": { "name": "GitHub List GPG Keys for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/gpg_keys", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the current user's GPG keys.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint." }, { "info": { "name": "GitHub Create a GPG Key for the Authenticated User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/gpg_keys", "body": { "type": "json", "data": "{}" } }, "docs": "Adds a GPG key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint." }, { "info": { "name": "GitHub Get a GPG Key for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/gpg_keys/:gpg_key_id", "params": [ { "name": "gpg_key_id", "value": "", "type": "path", "description": "The unique identifier of the GPG key." } ] }, "docs": "View extended details for a single GPG key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a GPG Key for the Authenticated User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/gpg_keys/:gpg_key_id", "params": [ { "name": "gpg_key_id", "value": "", "type": "path", "description": "The unique identifier of the GPG key." } ] }, "docs": "Removes a GPG key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint." }, { "info": { "name": "GitHub List Public SSH Keys for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/keys", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the public SSH keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint." }, { "info": { "name": "GitHub Create a Public SSH Key for the Authenticated User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/keys", "body": { "type": "json", "data": "{}" } }, "docs": "Adds a public SSH key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint." }, { "info": { "name": "GitHub Get a Public SSH Key for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/keys/:key_id", "params": [ { "name": "key_id", "value": "", "type": "path", "description": "The unique identifier of the key." } ] }, "docs": "View extended details for a single public SSH key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint." }, { "info": { "name": "GitHub Delete a Public SSH Key for the Authenticated User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/keys/:key_id", "params": [ { "name": "key_id", "value": "", "type": "path", "description": "The unique identifier of the key." } ] }, "docs": "Removes a public SSH key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint." }, { "info": { "name": "GitHub List Public Email Addresses for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/public_emails", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint." }, { "info": { "name": "GitHub List Social Accounts for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/social_accounts", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all of your social accounts." }, { "info": { "name": "GitHub Add Social Accounts for the Authenticated User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/social_accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Add one or more social accounts to the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint." }, { "info": { "name": "GitHub Delete Social Accounts for the Authenticated User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/social_accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Deletes one or more social accounts from the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint." }, { "info": { "name": "GitHub List SSH Signing Keys for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/ssh_signing_keys", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the SSH signing keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint." }, { "info": { "name": "GitHub Create a SSH Signing Key for the Authenticated User", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/user/ssh_signing_keys", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an SSH signing key for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint." }, { "info": { "name": "GitHub Get an SSH Signing Key for the Authenticated User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/user/ssh_signing_keys/:ssh_signing_key_id", "params": [ { "name": "ssh_signing_key_id", "value": "", "type": "path", "description": "The unique identifier of the SSH signing key." } ] }, "docs": "Gets extended details for an SSH signing key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint." }, { "info": { "name": "GitHub Delete an SSH Signing Key for the Authenticated User", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/user/ssh_signing_keys/:ssh_signing_key_id", "params": [ { "name": "ssh_signing_key_id", "value": "", "type": "path", "description": "The unique identifier of the SSH signing key." } ] }, "docs": "Deletes an SSH signing key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint." }, { "info": { "name": "GitHub List Users", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users", "params": [ { "name": "since", "value": "", "type": "query", "description": "A user ID. Only return users with an ID greater than this ID." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users." }, { "info": { "name": "GitHub Get a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Provides publicly available information about someone with a GitHub account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible " }, { "info": { "name": "GitHub List Followers of a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/followers", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the people following the specified user." }, { "info": { "name": "GitHub List the People a User Follows", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/following", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the people who the specified user follows." }, { "info": { "name": "GitHub Check if a User Follows Another User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/following/:target_user", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "target_user", "value": "example_value", "type": "path" } ] }, "docs": "GitHub Check if a User Follows Another User" }, { "info": { "name": "GitHub List GPG Keys for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/gpg_keys", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the GPG keys for a user. This information is accessible by anyone." }, { "info": { "name": "GitHub Get Contextual Information for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/hovercard", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "subject_type", "value": "organization", "type": "query", "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`." }, { "name": "subject_id", "value": "12345678", "type": "query", "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`." } ] }, "docs": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octoc" }, { "info": { "name": "GitHub List Public Keys for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/keys", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone." }, { "info": { "name": "GitHub List Social Accounts for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/social_accounts", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists social media accounts for a user. This endpoint is accessible by anyone." }, { "info": { "name": "GitHub List SSH Signing Keys for a User", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/users/:username/ssh_signing_keys", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists the SSH signing keys for a user. This operation is accessible by anyone." } ] } ], "bundled": true }