Lists all secrets available in an environment without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all secrets available in an environment without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates a new self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a new self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis 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.
\nOK
" } - ], - "descriptionHTML": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).
\nNote
\n\nThis 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.
\nLists all notifications for the current user in the specified repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists all notifications for the current user in the specified repository.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -104502,6 +104502,7 @@ } ], "previews": [], + "descriptionHTML": "List repositories that an app installation can access.
", "statusCodes": [ { "httpStatusCode": "200", @@ -104519,8 +104520,7 @@ "httpStatusCode": "403", "description": "Forbidden
" } - ], - "descriptionHTML": "List repositories that an app installation can access.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -135737,7 +135737,6 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -135747,7 +135746,8 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "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 in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -163702,7 +163702,6 @@ } ], "previews": [], - "descriptionHTML": "Returns information about the specified GitHub code of conduct.
", "statusCodes": [ { "httpStatusCode": "200", @@ -163716,7 +163715,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Returns information about the specified GitHub code of conduct.
" } ] }, @@ -190044,13 +190044,13 @@ } ], "previews": [], - "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -211274,7 +211274,6 @@ } ], "previews": [], - "descriptionHTML": "This endpoint allows you to check the status of the most recent configuration process:
\nNote that you may need to wait several seconds after you start a process before you can check its status.
\nThe different statuses are:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Status | Description |
|---|---|
PENDING | The job has not started yet |
CONFIGURING | The job is running |
DONE | The job has finished correctly |
FAILED | The job has finished unexpectedly |
Unauthorized
" } - ] + ], + "descriptionHTML": "This endpoint allows you to check the status of the most recent configuration process:
\nNote that you may need to wait several seconds after you start a process before you can check its status.
\nThe different statuses are:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Status | Description |
|---|---|
PENDING | The job has not started yet |
CONFIGURING | The job is running |
DONE | The job has finished correctly |
FAILED | The job has finished unexpectedly |
Applies settings on your instance. For a list of the available settings, see the Get settings endpoint.
\nNotes:
\napplication/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.ghe-set-password utility to change the management console password. For more information, see \"Command-line utilities.\"Unauthorized
" } - ], - "descriptionHTML": "Applies settings on your instance. For a list of the available settings, see the Get settings endpoint.
\nNotes:
\napplication/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.ghe-set-password utility to change the management console password. For more information, see \"Command-line utilities.\"Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
No Content
" } - ], - "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Get a random sentence from the Zen of GitHub
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get a random sentence from the Zen of GitHub
" + ] } ] }, @@ -343328,13 +343328,13 @@ } ], "previews": [], - "descriptionHTML": "List public organization memberships for the specified user.
\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 API instead.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "List public organization memberships for the specified user.
\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 API instead.
" } ], "custom-properties": [ @@ -344949,13 +344949,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Response - list of custom role names
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.
Check if a user is, publicly or privately, a member of the organization.
", "statusCodes": [ { "httpStatusCode": "204", @@ -346895,7 +346894,8 @@ "httpStatusCode": "404", "description": "Not Found if requester is an organization member and user is not a member
" } - ] + ], + "descriptionHTML": "Check if a user is, publicly or privately, a member of the organization.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -363918,7 +363918,6 @@ } ], "previews": [], - "descriptionHTML": "Delete a ruleset for an organization.
", "statusCodes": [ { "httpStatusCode": "204", @@ -363932,7 +363931,8 @@ "httpStatusCode": "500", "description": "Internal Error
" } - ] + ], + "descriptionHTML": "Delete a ruleset for an organization.
" } ], "security-managers": [ @@ -365213,7 +365213,6 @@ } ], "previews": [], - "descriptionHTML": "Updates a webhook configured in an organization. When you update a webhook,\nthe secret will be overwritten. If you previously had a secret set, you must\nprovide the same secret or set a new secret or the secret will be removed. If\nyou are only updating individual webhook config properties, use \"Update a webhook\nconfiguration for an organization\".
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Updates a webhook configured in an organization. When you update a webhook,\nthe secret will be overwritten. If you previously had a secret set, you must\nprovide the same secret or set a new secret or the secret will be removed. If\nyou are only updating individual webhook config properties, use \"Update a webhook\nconfiguration for an organization\".
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Gets a specific package metadata for a public package owned by a user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ] + ], + "descriptionHTML": "Gets a specific package metadata for a public package owned by a user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/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.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.OK
" } - ] + ], + "descriptionHTML": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/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.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.Warning
\n\nEndpoint closing down notice: This endpoint route is closing down 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 endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down 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 endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Users with push access to the repository can edit a release.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Users with push access to the repository can edit a release.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -461793,7 +461793,6 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", @@ -461803,7 +461802,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -463176,13 +463176,13 @@ } ], "previews": [], + "descriptionHTML": "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\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "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\".
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -463240,13 +463240,13 @@ } ], "previews": [], - "descriptionHTML": "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\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "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\".
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -496421,13 +496421,13 @@ } ], "previews": [], + "descriptionHTML": "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.\"
OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "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.\"
OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Not Found if project is not managed by this team
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo 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.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nif team synchronization is set up
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo 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.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nProvides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
\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, you would use a subject_type value of repository and a subject_id value of 1300192 (the ID of the Spoon-Knife repository).
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
\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, you would use a subject_type value of repository and a subject_id value of 1300192 (the ID of the Spoon-Knife repository).
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.