github
Module github
API
Definitions
ballerinax/github Ballerina library
Overview
GitHub is a widely used platform for version control and collaboration, allowing developers to work together on projects from anywhere. It hosts a vast array of both open-source and private projects, providing a suite of development tools for collaborative software development.
This Ballerina connector is designed to interface with GitHub's REST API (version 2022-11-28), facilitating programmatic access to GitHub's services. It enables developers to automate tasks, manage repositories, issues, pull requests, and more, directly from Ballerina applications.
Setup guide
To use the GitHub Connector in Ballerina, you must have a GitHub account and a Personal Access Token (PAT) for authentication. If you already have a GitHub account, you can integrate the connector with your existing account. If not, you can create a new GitHub account by visiting GitHub's Sign Up page and following the registration process. Once you have a GitHub account, you can proceed to create a PAT.
Step 1: Access GitHub Settings
- Once logged in, click on the profile picture in the top-right corner of the page.
- Select Settings from the dropdown menu.
Step 2: Navigate to Developer Settings
- Scroll down in the sidebar on the left side of the settings page.
- click on Developer settings located near the bottom.
Step 3: Go to Personal Access Tokens
-
Inside Developer Settings find and click on Personal access tokens.
Step 4: Generate a New Token
- Click on the Generate new token button (you might be asked to enter you password again for security purposes).
Step 5: Configure & Generate the Token
-
Note: Give your token a descriptive name so you can remember it's purpose
-
Expiration: Select the duration before the token expires (e.g., 30 days, 60 days, 90 days, custom, or no expiration).
-
Select Scopes: Scopes control access for the token. Choose what you need the token for (e.g., repo access, user data access). For typical repository operations, selecting
repo
is often sufficient.
Quickstart
To use the GitHub
connector in your Ballerina application, modify the .bal
file as follows:
Step 1: Import the connector
Import the ballerinax/github
package into your Ballerina project.
import ballerinax/github;
Step 2: Instantiate a new connector
Create a github:ConnectionConfig
with the obtained PAT and initialize the connector with it.
github:ConnectionConfig gitHubConfig = { auth: { token: authToken } }; github:Client github = check new (gitHubConfig);
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
Get Private Repositories of Authenticated User
github:Repository[] userRepos = check github->/user/repos(visibility = "private", 'type = ());
Create a Private Repository
github:User_repos_body body = { name: "New Test Repo Name", 'private: true, description: "New Test Repo Description" }; github:Repository createdRepo = check github->/user/repos.post(body);
Examples
The GitHub
connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering use cases like initializing a new project, creating issues, and managing pull requests.
-
Initialize a New GitHub Project - Create a new repository on GitHub, initialize it with a README file, and add collaborators to the repository.
-
Create and Assign an Issue in GitHub - Create a new issue on GitHub, assign it to a specific user, and add labels.
-
Create and Manage a PullRequest in GitHub - Create a pull request on GitHub, and request changes as necessary.
-
Star Ballerina-Platform Repositories - Fetch all repositories under the
ballerina-platform
organization on GitHub and star each of them
Clients
github: Client
GitHub's v3 REST API.
Constructor
Gets invoked to initialize the connector
.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.github.com" - URL of the target service
get .
GitHub API Root
get advisories
function get advisories(string? ghsa_id, "reviewed"|"malware"|"unreviewed" 'type, string? cve_id, "actions"|"composer"|"erlang"|"go"|"maven"|"npm"|"nuget"|"other"|"pip"|"pub"|"rubygems"|"rust"? ecosystem, "unknown"|"low"|"medium"|"high"|"critical"? severity, Cwes? cwes, boolean? is_withdrawn, Affects? affects, string? published, string? updated, string? modified, string? before, string? after, "asc"|"desc" direction, int per_page, "updated"|"published" sort) returns GlobalAdvisory[]|error
List global security advisories
Parameters
- ghsa_id string? (default ()) - If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.
- 'type "reviewed"|"malware"|"unreviewed" (default "reviewed") - If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.
- cve_id string? (default ()) - If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.
- ecosystem "actions"|"composer"|"erlang"|"go"|"maven"|"npm"|"nuget"|"other"|"pip"|"pub"|"rubygems"|"rust"? (default ()) - If specified, only advisories for these ecosystems will be returned.
- severity "unknown"|"low"|"medium"|"high"|"critical"? (default ()) - If specified, only advisories with these severities will be returned.
- cwes Cwes? (default ()) - If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.
Example:
cwes=79,284,22
orcwes[]=79&cwes[]=284&cwes[]=22
- is_withdrawn boolean? (default ()) - Whether to only return advisories that have been withdrawn.
- affects Affects? (default ()) - If specified, only return advisories that affect any of
package
orpackage@version
. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. Example:affects=package1,package2@1.0.0,package3@^2.0.0
oraffects[]=package1&affects[]=package2@1.0.0
- published string? (default ()) - If specified, only return advisories that were published on a date or date range. For more information on the syntax of the date range, see "Understanding the search syntax."
- updated string? (default ()) - If specified, only return advisories that were updated on a date or date range. For more information on the syntax of the date range, see "Understanding the search syntax."
- modified string? (default ()) - If specified, only show advisories that were updated or published on a date or date range. For more information on the syntax of the date range, see "Understanding the search syntax."
- before string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
- after string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- sort "updated"|"published" (default "published") - The property to sort the results by.
Return Type
- GlobalAdvisory[]|error - Response
get advisories/[string ghsa_id]
function get advisories/[string ghsa_id]() returns GlobalAdvisory|error
Get a global security advisory
Return Type
- GlobalAdvisory|error - Response
get app
function get app() returns Integration|error
Get the authenticated app
Return Type
- Integration|error - Response
post app-manifests/[string code]/conversions
function post app\-manifests/[string code]/conversions() returns ManifestConversions|error
Create a GitHub App from a manifest
Return Type
- ManifestConversions|error - Response
get app/hook/config
function get app/hook/config() returns WebhookConfig|error
Get a webhook configuration for an app
Return Type
- WebhookConfig|error - Response
patch app/hook/config
function patch app/hook/config(Hook_config_body payload) returns WebhookConfig|error
Update a webhook configuration for an app
Parameters
- payload Hook_config_body -
Return Type
- WebhookConfig|error - Response
get app/hook/deliveries
function get app/hook/deliveries(int per_page, string? cursor, boolean? redelivery) returns HookDeliveryItem[]|error
List deliveries for an app webhook
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- cursor string? (default ()) - 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.
- redelivery boolean? (default ()) -
Return Type
- HookDeliveryItem[]|error - Response
get app/hook/deliveries/[int delivery_id]
function get app/hook/deliveries/[int delivery_id]() returns HookDelivery|error
Get a delivery for an app webhook
Return Type
- HookDelivery|error - Response
post app/hook/deliveries/[int delivery_id]/attempts
function post app/hook/deliveries/[int delivery_id]/attempts() returns json|error
Redeliver a delivery for an app webhook
Return Type
- json|error - Accepted
get app/installation-requests
function get app/installation\-requests(int per_page, int page) returns IntegrationInstallationRequest[]|error
List installation requests for the authenticated app
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- IntegrationInstallationRequest[]|error - List of integration installation requests
get app/installations
function get app/installations(int per_page, int page, string? since, string? outdated) returns Installation[]|error
List installations for the authenticated app
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- outdated string? (default ()) -
Return Type
- Installation[]|error - The permissions the installation has are included under the
permissions
key.
get app/installations/[int installation_id]
function get app/installations/[int installation_id]() returns Installation|error
Get an installation for the authenticated app
Return Type
- Installation|error - Response
delete app/installations/[int installation_id]
Delete an installation for the authenticated app
post app/installations/[int installation_id]/access_tokens
function post app/installations/[int installation_id]/access_tokens(Installation_id_access_tokens_body payload) returns InstallationToken|error
Create an installation access token for an app
Parameters
- payload Installation_id_access_tokens_body -
Return Type
- InstallationToken|error - Response
put app/installations/[int installation_id]/suspended
Suspend an app installation
delete app/installations/[int installation_id]/suspended
Unsuspend an app installation
delete applications/[string client_id]/grant
function delete applications/[string client_id]/grant(Client_id_grant_body payload) returns Response|error
Delete an app authorization
Parameters
- payload Client_id_grant_body -
post applications/[string client_id]/token
function post applications/[string client_id]/token(Client_id_token_body payload) returns Authorization|error
Check a token
Parameters
- payload Client_id_token_body -
Return Type
- Authorization|error - Response
delete applications/[string client_id]/token
function delete applications/[string client_id]/token(Client_id_token_body_1 payload) returns Response|error
Delete an app token
Parameters
- payload Client_id_token_body_1 -
patch applications/[string client_id]/token
function patch applications/[string client_id]/token(Client_id_token_body_2 payload) returns Authorization|error
Reset a token
Parameters
- payload Client_id_token_body_2 -
Return Type
- Authorization|error - Response
post applications/[string client_id]/token/scoped
function post applications/[string client_id]/token/scoped(Token_scoped_body payload) returns Authorization|error
Create a scoped access token
Parameters
- payload Token_scoped_body -
Return Type
- Authorization|error - Response
get apps/[string app_slug]
function get apps/[string app_slug]() returns Integration|error
Get an app
Return Type
- Integration|error - Response
get assignments/[int assignment_id]
function get assignments/[int assignment_id]() returns ClassroomAssignment|error
Get an assignment
Return Type
- ClassroomAssignment|error - Response
get assignments/[int assignment_id]/accepted_assignments
function get assignments/[int assignment_id]/accepted_assignments(int page, int per_page) returns ClassroomAcceptedAssignment[]|error
List accepted assignments for an assignment
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- ClassroomAcceptedAssignment[]|error - Response
get assignments/[int assignment_id]/grades
function get assignments/[int assignment_id]/grades() returns ClassroomAssignmentGrade[]|error
Get assignment grades
Return Type
- ClassroomAssignmentGrade[]|error - Response
get classrooms
function get classrooms(int page, int per_page) returns SimpleClassroom[]|error
List classrooms
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- SimpleClassroom[]|error - Response
get classrooms/[int classroom_id]
Get a classroom
get classrooms/[int classroom_id]/assignments
function get classrooms/[int classroom_id]/assignments(int page, int per_page) returns SimpleClassroomAssignment[]|error
List assignments for a classroom
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- SimpleClassroomAssignment[]|error - Response
get codes_of_conduct
function get codes_of_conduct() returns CodeOfConduct[]|error?
Get all codes of conduct
Return Type
- CodeOfConduct[]|error? - Response
get codes_of_conduct/[string 'key]
function get codes_of_conduct/[string 'key]() returns CodeOfConduct|error?
Get a code of conduct
Return Type
- CodeOfConduct|error? - Response
get emojis
function get emojis() returns json|error?
Get emojis
Return Type
- json|error? - Response
get enterprises/[string enterprise]/dependabot/alerts
function get enterprises/[string enterprise]/dependabot/alerts(string? state, string? severity, string? ecosystem, string? package, "development"|"runtime"? scope, "created"|"updated" sort, "asc"|"desc" direction, string? before, string? after, int first, int? last, int per_page) returns DependabotAlertWithRepository[]|error
List Dependabot alerts for an enterprise
Parameters
- state string? (default ()) - A comma-separated list of states. If specified, only alerts with these states will be returned.
Can be:
auto_dismissed
,dismissed
,fixed
,open
- severity string? (default ()) - A comma-separated list of severities. If specified, only alerts with these severities will be returned.
Can be:
low
,medium
,high
,critical
- ecosystem string? (default ()) - A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
Can be:
composer
,go
,maven
,npm
,nuget
,pip
,pub
,rubygems
,rust
- package string? (default ()) - A comma-separated list of package names. If specified, only alerts for these packages will be returned.
- scope "development"|"runtime"? (default ()) - The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.
- sort "created"|"updated" (default "created") - The property by which to sort the results.
created
means when the alert was created.updated
means when the alert's state last changed.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- before string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
- after string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
- first int (default 30) - Deprecated. The number of results per page (max 100), starting from the first matching result.
This parameter must not be used in combination with
last
. Instead, useper_page
in combination withafter
to fetch the first page of results.
- last int? (default ()) - Deprecated. The number of results per page (max 100), starting from the last matching result.
This parameter must not be used in combination with
first
. Instead, useper_page
in combination withbefore
to fetch the last page of results.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- DependabotAlertWithRepository[]|error - Response
get enterprises/[string enterprise]/secret-scanning/alerts
function get enterprises/[string enterprise]/secret\-scanning/alerts("open"|"resolved"? state, string? secret_type, string? resolution, "created"|"updated" sort, "asc"|"desc" direction, int per_page, string? before, string? after) returns OrganizationSecretScanningAlert[]|error
List secret scanning alerts for an enterprise
Parameters
- state "open"|"resolved"? (default ()) - Set to
open
orresolved
to only list secret scanning alerts in a specific state.
- secret_type string? (default ()) - A comma-separated list of secret types to return. By default all secret types are returned. See "Secret scanning patterns" for a complete list of secret types.
- resolution string? (default ()) - 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
orused_in_tests
.
- sort "created"|"updated" (default "created") - The property to sort the results by.
created
means when the alert was created.updated
means when the alert was updated or resolved.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- before string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
- after string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
Return Type
- OrganizationSecretScanningAlert[]|error - Response
get events
List public events
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get feeds
Get feeds
get gists
List gists for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post gists
function post gists(Gists_body payload) returns GistSimple|error
Create a gist
Parameters
- payload Gists_body -
Return Type
- GistSimple|error - Response
get gists/'public
List public gists
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get gists/starred
List starred gists
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get gists/[string gist_id]
function get gists/[string gist_id]() returns GistSimple|error?
Get a gist
Return Type
- GistSimple|error? - Response
delete gists/[string gist_id]
Delete a gist
patch gists/[string gist_id]
function patch gists/[string gist_id](Gists_gist_id_body payload) returns GistSimple|error
Update a gist
Parameters
- payload Gists_gist_id_body -
Return Type
- GistSimple|error - Response
get gists/[string gist_id]/comments
function get gists/[string gist_id]/comments(int per_page, int page) returns GistComment[]|error
List gist comments
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- GistComment[]|error - Response
post gists/[string gist_id]/comments
function post gists/[string gist_id]/comments(Gist_id_comments_body payload) returns GistComment|error
Create a gist comment
Parameters
- payload Gist_id_comments_body -
Return Type
- GistComment|error - Response
get gists/[string gist_id]/comments/[int comment_id]
function get gists/[string gist_id]/comments/[int comment_id]() returns GistComment|error
Get a gist comment
Return Type
- GistComment|error - Response
delete gists/[string gist_id]/comments/[int comment_id]
Delete a gist comment
patch gists/[string gist_id]/comments/[int comment_id]
function patch gists/[string gist_id]/comments/[int comment_id](Comments_comment_id_body payload) returns GistComment|error
Update a gist comment
Parameters
- payload Comments_comment_id_body -
Return Type
- GistComment|error - Response
get gists/[string gist_id]/commits
function get gists/[string gist_id]/commits(int per_page, int page) returns GistCommit[]|error
List gist commits
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- GistCommit[]|error - Response
get gists/[string gist_id]/forks
function get gists/[string gist_id]/forks(int per_page, int page) returns GistSimple[]|error
List gist forks
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- GistSimple[]|error - Response
post gists/[string gist_id]/forks
Fork a gist
get gists/[string gist_id]/star
Check if a gist is starred
put gists/[string gist_id]/star
Star a gist
delete gists/[string gist_id]/star
Unstar a gist
get gists/[string gist_id]/[string sha]
function get gists/[string gist_id]/[string sha]() returns GistSimple|error
Get a gist revision
Return Type
- GistSimple|error - Response
get gitignore/templates
Get all gitignore templates
get gitignore/templates/[string name]
function get gitignore/templates/[string name]() returns GitignoreTemplate|error?
Get a gitignore template
Return Type
- GitignoreTemplate|error? - Response
get installation/repositories
function get installation/repositories(int per_page, int page) returns RepositoryResponse|error
List repositories accessible to the app installation
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RepositoryResponse|error - Response
delete installation/token
function delete installation/token() returns error?
Revoke an installation access token
Return Type
- error? - Response
get issues
function get issues("assigned"|"created"|"mentioned"|"subscribed"|"repos"|"all" filter, "open"|"closed"|"all" state, string? labels, "created"|"updated"|"comments" sort, "asc"|"desc" direction, string? since, boolean? collab, boolean? orgs, boolean? owned, boolean? pulls, int per_page, int page) returns Issue[]|error
List issues assigned to the authenticated user
Parameters
- filter "assigned"|"created"|"mentioned"|"subscribed"|"repos"|"all" (default "assigned") - 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
orrepos
means all issues you can see, regardless of participation or creation.
- state "open"|"closed"|"all" (default "open") - Indicates the state of the issues to return.
- labels string? (default ()) - A list of comma separated label names. Example:
bug,ui,@high
- sort "created"|"updated"|"comments" (default "created") - What to sort results by.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- collab boolean? (default ()) -
- orgs boolean? (default ()) -
- owned boolean? (default ()) -
- pulls boolean? (default ()) -
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get licenses
function get licenses(boolean? featured, int per_page, int page) returns LicenseSimple[]|error?
Get all commonly used licenses
Parameters
- featured boolean? (default ()) -
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- LicenseSimple[]|error? - Response
get licenses/[string license]
Get a license
post markdown
function post markdown(Markdown_body payload) returns string|error?
Render a Markdown document
Parameters
- payload Markdown_body -
post markdown/raw
Render a Markdown document in raw mode
Parameters
- payload string -
get marketplace_listing/accounts/[int account_id]
function get marketplace_listing/accounts/[int account_id]() returns MarketplacePurchase|error
Get a subscription plan for an account
Return Type
- MarketplacePurchase|error - Response
get marketplace_listing/plans
function get marketplace_listing/plans(int per_page, int page) returns MarketplaceListingPlan[]|error
List plans
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MarketplaceListingPlan[]|error - Response
get marketplace_listing/plans/[int plan_id]/accounts
function get marketplace_listing/plans/[int plan_id]/accounts("created"|"updated" sort, "asc"|"desc"? direction, int per_page, int page) returns MarketplacePurchase[]|error
List accounts for a plan
Parameters
- sort "created"|"updated" (default "created") - The property to sort the results by.
- direction "asc"|"desc"? (default ()) - To return the oldest accounts first, set to
asc
. Ignored without thesort
parameter.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MarketplacePurchase[]|error - Response
get marketplace_listing/stubbed/accounts/[int account_id]
function get marketplace_listing/stubbed/accounts/[int account_id]() returns MarketplacePurchase|error
Get a subscription plan for an account (stubbed)
Return Type
- MarketplacePurchase|error - Response
get marketplace_listing/stubbed/plans
function get marketplace_listing/stubbed/plans(int per_page, int page) returns MarketplaceListingPlan[]|error
List plans (stubbed)
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MarketplaceListingPlan[]|error - Response
get marketplace_listing/stubbed/plans/[int plan_id]/accounts
function get marketplace_listing/stubbed/plans/[int plan_id]/accounts("created"|"updated" sort, "asc"|"desc"? direction, int per_page, int page) returns MarketplacePurchase[]|error
List accounts for a plan (stubbed)
Parameters
- sort "created"|"updated" (default "created") - The property to sort the results by.
- direction "asc"|"desc"? (default ()) - To return the oldest accounts first, set to
asc
. Ignored without thesort
parameter.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MarketplacePurchase[]|error - Response
get meta
function get meta() returns ApiOverview|error?
Get GitHub meta information
Return Type
- ApiOverview|error? - Response
get networks/[string owner]/[string repo]/events
function get networks/[string owner]/[string repo]/events(int per_page, int page) returns Event[]|error
List public events for a network of repositories
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get notifications
function get notifications(boolean all, boolean participating, string? since, string? before, int page, int per_page) returns NotificationThread[]|error
List notifications for the authenticated user
Parameters
- all boolean (default false) - If
true
, show notifications marked as read.
- participating boolean (default false) - If
true
, only shows notifications in which the user is directly participating or mentioned.
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 50) - The number of results per page (max 50).
Return Type
- NotificationThread[]|error - Response
put notifications
function put notifications(Notifications_body payload) returns NotificationRead|error
Mark notifications as read
Parameters
- payload Notifications_body -
Return Type
- NotificationRead|error - Response
get notifications/threads/[int thread_id]
function get notifications/threads/[int thread_id]() returns NotificationThread|error
Get a thread
Return Type
- NotificationThread|error - Response
patch notifications/threads/[int thread_id]
Mark a thread as read
get notifications/threads/[int thread_id]/subscription
function get notifications/threads/[int thread_id]/subscription() returns ThreadSubscription|error
Get a thread subscription for the authenticated user
Return Type
- ThreadSubscription|error - Response
put notifications/threads/[int thread_id]/subscription
function put notifications/threads/[int thread_id]/subscription(Thread_id_subscription_body payload) returns ThreadSubscription|error
Set a thread subscription
Parameters
- payload Thread_id_subscription_body -
Return Type
- ThreadSubscription|error - Response
delete notifications/threads/[int thread_id]/subscription
Delete a thread subscription
get octocat
Get Octocat
Parameters
- s string? (default ()) - The words to show in Octocat's speech bubble
get organizations
function get organizations(int? since, int per_page) returns OrganizationSimple[]|error?
List organizations
Parameters
- since int? (default ()) - An organization ID. Only return organizations with an ID greater than this ID.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- OrganizationSimple[]|error? - Response
get orgs/[string org]
function get orgs/[string org]() returns OrganizationFull|error
Get an organization
Return Type
- OrganizationFull|error - Response
delete orgs/[string org]
function delete orgs/[string org]() returns json|error
Delete an organization
Return Type
- json|error - Accepted
patch orgs/[string org]
function patch orgs/[string org](Orgs_org_body payload) returns OrganizationFull|error
Update an organization
Parameters
- payload Orgs_org_body -
Return Type
- OrganizationFull|error - Response
get orgs/[string org]/actions/cache/usage
function get orgs/[string org]/actions/cache/usage() returns ActionsCacheUsageOrgEnterprise|error
Get GitHub Actions cache usage for an organization
Return Type
- ActionsCacheUsageOrgEnterprise|error - Response
get orgs/[string org]/actions/cache/usage-by-repository
function get orgs/[string org]/actions/cache/usage\-by\-repository(int per_page, int page) returns ActionsCacheUsageByRepositoryResponse|error
List repositories with GitHub Actions cache usage for an organization
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ActionsCacheUsageByRepositoryResponse|error - Response
get orgs/[string org]/actions/oidc/customization/sub
function get orgs/[string org]/actions/oidc/customization/sub() returns OidcCustomSub|error
Get the customization template for an OIDC subject claim for an organization
Return Type
- OidcCustomSub|error - A JSON serialized template for OIDC subject claim customization
put orgs/[string org]/actions/oidc/customization/sub
function put orgs/[string org]/actions/oidc/customization/sub(OidcCustomSub payload) returns EmptyObject|error
Set the customization template for an OIDC subject claim for an organization
Parameters
- payload OidcCustomSub -
Return Type
- EmptyObject|error - Empty response
get orgs/[string org]/actions/permissions
function get orgs/[string org]/actions/permissions() returns ActionsOrganizationPermissions|error
Get GitHub Actions permissions for an organization
Return Type
- ActionsOrganizationPermissions|error - Response
put orgs/[string org]/actions/permissions
function put orgs/[string org]/actions/permissions(Actions_permissions_body payload) returns error?
Set GitHub Actions permissions for an organization
Parameters
- payload Actions_permissions_body -
Return Type
- error? - Response
get orgs/[string org]/actions/permissions/repositories
function get orgs/[string org]/actions/permissions/repositories(int per_page, int page) returns RepositoryResponse|error
List selected repositories enabled for GitHub Actions in an organization
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RepositoryResponse|error - Response
put orgs/[string org]/actions/permissions/repositories
function put orgs/[string org]/actions/permissions/repositories(Permissions_repositories_body payload) returns error?
Set selected repositories enabled for GitHub Actions in an organization
Parameters
- payload Permissions_repositories_body -
Return Type
- error? - Response
put orgs/[string org]/actions/permissions/repositories/[int repository_id]
function put orgs/[string org]/actions/permissions/repositories/[int repository_id]() returns error?
Enable a selected repository for GitHub Actions in an organization
Return Type
- error? - Response
delete orgs/[string org]/actions/permissions/repositories/[int repository_id]
function delete orgs/[string org]/actions/permissions/repositories/[int repository_id]() returns error?
Disable a selected repository for GitHub Actions in an organization
Return Type
- error? - Response
get orgs/[string org]/actions/permissions/selected-actions
function get orgs/[string org]/actions/permissions/selected\-actions() returns SelectedActions|error
Get allowed actions and reusable workflows for an organization
Return Type
- SelectedActions|error - Response
put orgs/[string org]/actions/permissions/selected-actions
function put orgs/[string org]/actions/permissions/selected\-actions(SelectedActions payload) returns error?
Set allowed actions and reusable workflows for an organization
Parameters
- payload SelectedActions -
Return Type
- error? - Response
get orgs/[string org]/actions/permissions/workflow
function get orgs/[string org]/actions/permissions/workflow() returns ActionsGetDefaultWorkflowPermissions|error
Get default workflow permissions for an organization
Return Type
- ActionsGetDefaultWorkflowPermissions|error - Response
put orgs/[string org]/actions/permissions/workflow
function put orgs/[string org]/actions/permissions/workflow(ActionsSetDefaultWorkflowPermissions payload) returns error?
Set default workflow permissions for an organization
Parameters
- payload ActionsSetDefaultWorkflowPermissions -
Return Type
- error? - Success response
get orgs/[string org]/actions/runners
function get orgs/[string org]/actions/runners(string? name, int per_page, int page) returns RunnerResponse|error
List self-hosted runners for an organization
Parameters
- name string? (default ()) - The name of a self-hosted runner.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RunnerResponse|error - Response
get orgs/[string org]/actions/runners/downloads
function get orgs/[string org]/actions/runners/downloads() returns RunnerApplication[]|error
List runner applications for an organization
Return Type
- RunnerApplication[]|error - Response
post orgs/[string org]/actions/runners/generate-jitconfig
function post orgs/[string org]/actions/runners/generate\-jitconfig(Runners_generatejitconfig_body payload) returns JitConfig|error
Create configuration for a just-in-time runner for an organization
Parameters
- payload Runners_generatejitconfig_body -
post orgs/[string org]/actions/runners/registration-token
function post orgs/[string org]/actions/runners/registration\-token() returns AuthenticationToken|error
Create a registration token for an organization
Return Type
- AuthenticationToken|error - Response
post orgs/[string org]/actions/runners/remove-token
function post orgs/[string org]/actions/runners/remove\-token() returns AuthenticationToken|error
Create a remove token for an organization
Return Type
- AuthenticationToken|error - Response
get orgs/[string org]/actions/runners/[int runner_id]
Get a self-hosted runner for an organization
delete orgs/[string org]/actions/runners/[int runner_id]
function delete orgs/[string org]/actions/runners/[int runner_id]() returns error?
Delete a self-hosted runner from an organization
Return Type
- error? - Response
get orgs/[string org]/actions/runners/[int runner_id]/labels
function get orgs/[string org]/actions/runners/[int runner_id]/labels() returns RunnerLabelResponse|error
List labels for a self-hosted runner for an organization
Return Type
- RunnerLabelResponse|error - Response
put orgs/[string org]/actions/runners/[int runner_id]/labels
function put orgs/[string org]/actions/runners/[int runner_id]/labels(Runner_id_labels_body payload) returns RunnerLabelResponse|error
Set custom labels for a self-hosted runner for an organization
Parameters
- payload Runner_id_labels_body -
Return Type
- RunnerLabelResponse|error - Response
post orgs/[string org]/actions/runners/[int runner_id]/labels
function post orgs/[string org]/actions/runners/[int runner_id]/labels(Runner_id_labels_body_1 payload) returns RunnerLabelResponse|error
Add custom labels to a self-hosted runner for an organization
Parameters
- payload Runner_id_labels_body_1 -
Return Type
- RunnerLabelResponse|error - Response
delete orgs/[string org]/actions/runners/[int runner_id]/labels
function delete orgs/[string org]/actions/runners/[int runner_id]/labels() returns RunnerLabelResponse|error
Remove all custom labels from a self-hosted runner for an organization
Return Type
- RunnerLabelResponse|error - Response
delete orgs/[string org]/actions/runners/[int runner_id]/labels/[string name]
function delete orgs/[string org]/actions/runners/[int runner_id]/labels/[string name]() returns RunnerLabelResponse|error
Remove a custom label from a self-hosted runner for an organization
Return Type
- RunnerLabelResponse|error - Response
get orgs/[string org]/actions/secrets
function get orgs/[string org]/actions/secrets(int per_page, int page) returns OrganizationActionsSecretResponse|error
List organization secrets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- OrganizationActionsSecretResponse|error - Response
get orgs/[string org]/actions/secrets/public-key
function get orgs/[string org]/actions/secrets/public\-key() returns ActionsPublicKey|error
Get an organization public key
Return Type
- ActionsPublicKey|error - Response
get orgs/[string org]/actions/secrets/[string secret_name]
function get orgs/[string org]/actions/secrets/[string secret_name]() returns OrganizationActionsSecret|error
Get an organization secret
Return Type
- OrganizationActionsSecret|error - Response
put orgs/[string org]/actions/secrets/[string secret_name]
function put orgs/[string org]/actions/secrets/[string secret_name](Secrets_secret_name_body payload) returns EmptyObject|error?
Create or update an organization secret
Parameters
- payload Secrets_secret_name_body -
Return Type
- EmptyObject|error? - Response when creating a secret
delete orgs/[string org]/actions/secrets/[string secret_name]
function delete orgs/[string org]/actions/secrets/[string secret_name]() returns error?
Delete an organization secret
Return Type
- error? - Response
get orgs/[string org]/actions/secrets/[string secret_name]/repositories
function get orgs/[string org]/actions/secrets/[string secret_name]/repositories(int page, int per_page) returns MinimalRepositoryResponse|error
List selected repositories for an organization secret
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- MinimalRepositoryResponse|error - Response
put orgs/[string org]/actions/secrets/[string secret_name]/repositories
function put orgs/[string org]/actions/secrets/[string secret_name]/repositories(Secret_name_repositories_body payload) returns error?
Set selected repositories for an organization secret
Parameters
- payload Secret_name_repositories_body -
Return Type
- error? - Response
put orgs/[string org]/actions/secrets/[string secret_name]/repositories/[int repository_id]
function put orgs/[string org]/actions/secrets/[string secret_name]/repositories/[int repository_id]() returns Response|error
Add selected repository to an organization secret
delete orgs/[string org]/actions/secrets/[string secret_name]/repositories/[int repository_id]
function delete orgs/[string org]/actions/secrets/[string secret_name]/repositories/[int repository_id]() returns Response|error
Remove selected repository from an organization secret
get orgs/[string org]/actions/variables
function get orgs/[string org]/actions/variables(int per_page, int page) returns OrganizationActionsVariableResponse|error
List organization variables
Parameters
- per_page int (default 10) - The number of results per page (max 30).
- page int (default 1) - Page number of the results to fetch.
Return Type
- OrganizationActionsVariableResponse|error - Response
post orgs/[string org]/actions/variables
function post orgs/[string org]/actions/variables(Actions_variables_body payload) returns EmptyObject|error
Create an organization variable
Parameters
- payload Actions_variables_body -
Return Type
- EmptyObject|error - Response when creating a variable
get orgs/[string org]/actions/variables/[string name]
function get orgs/[string org]/actions/variables/[string name]() returns OrganizationActionsVariable|error
Get an organization variable
Return Type
- OrganizationActionsVariable|error - Response
delete orgs/[string org]/actions/variables/[string name]
function delete orgs/[string org]/actions/variables/[string name]() returns error?
Delete an organization variable
Return Type
- error? - Response
patch orgs/[string org]/actions/variables/[string name]
function patch orgs/[string org]/actions/variables/[string name](Variables_name_body payload) returns error?
Update an organization variable
Parameters
- payload Variables_name_body -
Return Type
- error? - Response
get orgs/[string org]/actions/variables/[string name]/repositories
function get orgs/[string org]/actions/variables/[string name]/repositories(int page, int per_page) returns MinimalRepositoryResponse|error
List selected repositories for an organization variable
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- MinimalRepositoryResponse|error - Response
put orgs/[string org]/actions/variables/[string name]/repositories
function put orgs/[string org]/actions/variables/[string name]/repositories(Name_repositories_body payload) returns Response|error
Set selected repositories for an organization variable
Parameters
- payload Name_repositories_body -
put orgs/[string org]/actions/variables/[string name]/repositories/[int repository_id]
function put orgs/[string org]/actions/variables/[string name]/repositories/[int repository_id]() returns Response|error
Add selected repository to an organization variable
delete orgs/[string org]/actions/variables/[string name]/repositories/[int repository_id]
function delete orgs/[string org]/actions/variables/[string name]/repositories/[int repository_id]() returns Response|error
Remove selected repository from an organization variable
get orgs/[string org]/blocks
function get orgs/[string org]/blocks(int per_page, int page) returns SimpleUser[]|error
List users blocked by an organization
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get orgs/[string org]/blocks/[string username]
Check if a user is blocked by an organization
put orgs/[string org]/blocks/[string username]
Block a user from an organization
delete orgs/[string org]/blocks/[string username]
function delete orgs/[string org]/blocks/[string username]() returns error?
Unblock a user from an organization
Return Type
- error? - Response
get orgs/[string org]/code-scanning/alerts
function get orgs/[string org]/code\-scanning/alerts(CodeScanningAnalysisToolName? tool_name, CodeScanningAnalysisToolGuid? tool_guid, string? before, string? after, int page, int per_page, "asc"|"desc" direction, CodeScanningAlertStateQuery? state, "created"|"updated" sort, CodeScanningAlertSeverity? severity) returns CodeScanningOrganizationAlertItems[]|error
List code scanning alerts for an organization
Parameters
- tool_name CodeScanningAnalysisToolName? (default ()) - 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
ortool_guid
, but not both.
- tool_guid CodeScanningAnalysisToolGuid? (default ()) - 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
ortool_name
, but not both.
- before string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
- after string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- state CodeScanningAlertStateQuery? (default ()) - If specified, only code scanning alerts with this state will be returned.
- sort "created"|"updated" (default "created") - The property by which to sort the results.
- severity CodeScanningAlertSeverity? (default ()) - If specified, only code scanning alerts with this severity will be returned.
Return Type
- CodeScanningOrganizationAlertItems[]|error - Response
get orgs/[string org]/codespaces
function get orgs/[string org]/codespaces(int per_page, int page) returns CodespaceResponse|error
List codespaces for the organization
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CodespaceResponse|error - Response
put orgs/[string org]/codespaces/access
function put orgs/[string org]/codespaces/access(Codespaces_access_body payload) returns Response|error
Manage access control for organization codespaces
Parameters
- payload Codespaces_access_body -
post orgs/[string org]/codespaces/access/selected_users
function post orgs/[string org]/codespaces/access/selected_users(Access_selected_users_body payload) returns Response|error
Add users to Codespaces access for an organization
Parameters
- payload Access_selected_users_body -
delete orgs/[string org]/codespaces/access/selected_users
function delete orgs/[string org]/codespaces/access/selected_users(Access_selected_users_body_1 payload) returns Response|error
Remove users from Codespaces access for an organization
Parameters
- payload Access_selected_users_body_1 -
get orgs/[string org]/codespaces/secrets
function get orgs/[string org]/codespaces/secrets(int per_page, int page) returns CodespacesOrgSecretResponse|error
List organization secrets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CodespacesOrgSecretResponse|error - Response
get orgs/[string org]/codespaces/secrets/public-key
function get orgs/[string org]/codespaces/secrets/public\-key() returns CodespacesPublicKey|error
Get an organization public key
Return Type
- CodespacesPublicKey|error - Response
get orgs/[string org]/codespaces/secrets/[string secret_name]
function get orgs/[string org]/codespaces/secrets/[string secret_name]() returns CodespacesOrgSecret|error
Get an organization secret
Return Type
- CodespacesOrgSecret|error - Response
put orgs/[string org]/codespaces/secrets/[string secret_name]
function put orgs/[string org]/codespaces/secrets/[string secret_name](Secrets_secret_name_body_1 payload) returns EmptyObject|error
Create or update an organization secret
Parameters
- payload Secrets_secret_name_body_1 -
Return Type
- EmptyObject|error - Response when creating a secret
delete orgs/[string org]/codespaces/secrets/[string secret_name]
Delete an organization secret
get orgs/[string org]/codespaces/secrets/[string secret_name]/repositories
function get orgs/[string org]/codespaces/secrets/[string secret_name]/repositories(int page, int per_page) returns MinimalRepositoryResponse|error
List selected repositories for an organization secret
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- MinimalRepositoryResponse|error - Response
put orgs/[string org]/codespaces/secrets/[string secret_name]/repositories
function put orgs/[string org]/codespaces/secrets/[string secret_name]/repositories(Secret_name_repositories_body_1 payload) returns Response|error
Set selected repositories for an organization secret
Parameters
- payload Secret_name_repositories_body_1 -
put orgs/[string org]/codespaces/secrets/[string secret_name]/repositories/[int repository_id]
function put orgs/[string org]/codespaces/secrets/[string secret_name]/repositories/[int repository_id]() returns Response|error
Add selected repository to an organization secret
delete orgs/[string org]/codespaces/secrets/[string secret_name]/repositories/[int repository_id]
function delete orgs/[string org]/codespaces/secrets/[string secret_name]/repositories/[int repository_id]() returns Response|error
Remove selected repository from an organization secret
get orgs/[string org]/copilot/billing
function get orgs/[string org]/copilot/billing() returns CopilotOrganizationDetails|error
Get Copilot for Business seat information and settings for an organization
Return Type
get orgs/[string org]/copilot/billing/seats
function get orgs/[string org]/copilot/billing/seats(int page, int per_page) returns CopilotSeatDetailsResponse|error
List all Copilot for Business seat assignments for an organization
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 50) - The number of results per page (max 100).
Return Type
- CopilotSeatDetailsResponse|error - Response
post orgs/[string org]/copilot/billing/selected_teams
function post orgs/[string org]/copilot/billing/selected_teams(Billing_selected_teams_body payload) returns CopilotSeatCreated|error
Add teams to the Copilot for Business subscription for an organization
Parameters
- payload Billing_selected_teams_body -
Return Type
- CopilotSeatCreated|error - OK
delete orgs/[string org]/copilot/billing/selected_teams
function delete orgs/[string org]/copilot/billing/selected_teams(Billing_selected_teams_body_1 payload) returns CopilotSeatCancelled|error
Remove teams from the Copilot for Business subscription for an organization
Parameters
- payload Billing_selected_teams_body_1 -
Return Type
post orgs/[string org]/copilot/billing/selected_users
function post orgs/[string org]/copilot/billing/selected_users(Billing_selected_users_body payload) returns CopilotSeatCreated|error
Add users to the Copilot for Business subscription for an organization
Parameters
- payload Billing_selected_users_body -
Return Type
- CopilotSeatCreated|error - OK
delete orgs/[string org]/copilot/billing/selected_users
function delete orgs/[string org]/copilot/billing/selected_users(Billing_selected_users_body_1 payload) returns CopilotSeatCancelled|error
Remove users from the Copilot for Business subscription for an organization
Parameters
- payload Billing_selected_users_body_1 -
Return Type
get orgs/[string org]/dependabot/alerts
function get orgs/[string org]/dependabot/alerts(string? state, string? severity, string? ecosystem, string? package, "development"|"runtime"? scope, "created"|"updated" sort, "asc"|"desc" direction, string? before, string? after, int first, int? last, int per_page) returns DependabotAlertWithRepository[]|error
List Dependabot alerts for an organization
Parameters
- state string? (default ()) - A comma-separated list of states. If specified, only alerts with these states will be returned.
Can be:
auto_dismissed
,dismissed
,fixed
,open
- severity string? (default ()) - A comma-separated list of severities. If specified, only alerts with these severities will be returned.
Can be:
low
,medium
,high
,critical
- ecosystem string? (default ()) - A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
Can be:
composer
,go
,maven
,npm
,nuget
,pip
,pub
,rubygems
,rust
- package string? (default ()) - A comma-separated list of package names. If specified, only alerts for these packages will be returned.
- scope "development"|"runtime"? (default ()) - The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.
- sort "created"|"updated" (default "created") - The property by which to sort the results.
created
means when the alert was created.updated
means when the alert's state last changed.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- before string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
- after string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
- first int (default 30) - Deprecated. The number of results per page (max 100), starting from the first matching result.
This parameter must not be used in combination with
last
. Instead, useper_page
in combination withafter
to fetch the first page of results.
- last int? (default ()) - Deprecated. The number of results per page (max 100), starting from the last matching result.
This parameter must not be used in combination with
first
. Instead, useper_page
in combination withbefore
to fetch the last page of results.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- DependabotAlertWithRepository[]|error - Response
get orgs/[string org]/dependabot/secrets
function get orgs/[string org]/dependabot/secrets(int per_page, int page) returns OrganizationDependabotSecretResponse|error
List organization secrets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- OrganizationDependabotSecretResponse|error - Response
get orgs/[string org]/dependabot/secrets/public-key
function get orgs/[string org]/dependabot/secrets/public\-key() returns DependabotPublicKey|error
Get an organization public key
Return Type
- DependabotPublicKey|error - Response
get orgs/[string org]/dependabot/secrets/[string secret_name]
function get orgs/[string org]/dependabot/secrets/[string secret_name]() returns OrganizationDependabotSecret|error
Get an organization secret
Return Type
- OrganizationDependabotSecret|error - Response
put orgs/[string org]/dependabot/secrets/[string secret_name]
function put orgs/[string org]/dependabot/secrets/[string secret_name](Secrets_secret_name_body_2 payload) returns EmptyObject|error?
Create or update an organization secret
Parameters
- payload Secrets_secret_name_body_2 -
Return Type
- EmptyObject|error? - Response when creating a secret
delete orgs/[string org]/dependabot/secrets/[string secret_name]
function delete orgs/[string org]/dependabot/secrets/[string secret_name]() returns error?
Delete an organization secret
Return Type
- error? - Response
get orgs/[string org]/dependabot/secrets/[string secret_name]/repositories
function get orgs/[string org]/dependabot/secrets/[string secret_name]/repositories(int page, int per_page) returns MinimalRepositoryResponse|error
List selected repositories for an organization secret
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- MinimalRepositoryResponse|error - Response
put orgs/[string org]/dependabot/secrets/[string secret_name]/repositories
function put orgs/[string org]/dependabot/secrets/[string secret_name]/repositories(Secret_name_repositories_body_2 payload) returns error?
Set selected repositories for an organization secret
Parameters
- payload Secret_name_repositories_body_2 -
Return Type
- error? - Response
put orgs/[string org]/dependabot/secrets/[string secret_name]/repositories/[int repository_id]
function put orgs/[string org]/dependabot/secrets/[string secret_name]/repositories/[int repository_id]() returns Response|error
Add selected repository to an organization secret
delete orgs/[string org]/dependabot/secrets/[string secret_name]/repositories/[int repository_id]
function delete orgs/[string org]/dependabot/secrets/[string secret_name]/repositories/[int repository_id]() returns Response|error
Remove selected repository from an organization secret
get orgs/[string org]/docker/conflicts
Get list of conflicting packages during Docker migration for organization
get orgs/[string org]/events
List public organization events
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get orgs/[string org]/failed_invitations
function get orgs/[string org]/failed_invitations(int per_page, int page) returns OrganizationInvitation[]|error
List failed organization invitations
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- OrganizationInvitation[]|error - Response
get orgs/[string org]/hooks
List organization webhooks
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post orgs/[string org]/hooks
function post orgs/[string org]/hooks(Org_hooks_body payload) returns OrgHook|error
Create an organization webhook
Parameters
- payload Org_hooks_body -
get orgs/[string org]/hooks/[int hook_id]
Get an organization webhook
delete orgs/[string org]/hooks/[int hook_id]
Delete an organization webhook
patch orgs/[string org]/hooks/[int hook_id]
function patch orgs/[string org]/hooks/[int hook_id](Hooks_hook_id_body payload) returns OrgHook|error
Update an organization webhook
Parameters
- payload Hooks_hook_id_body -
get orgs/[string org]/hooks/[int hook_id]/config
function get orgs/[string org]/hooks/[int hook_id]/config() returns WebhookConfig|error
Get a webhook configuration for an organization
Return Type
- WebhookConfig|error - Response
patch orgs/[string org]/hooks/[int hook_id]/config
function patch orgs/[string org]/hooks/[int hook_id]/config(Hook_id_config_body payload) returns WebhookConfig|error
Update a webhook configuration for an organization
Parameters
- payload Hook_id_config_body -
Return Type
- WebhookConfig|error - Response
get orgs/[string org]/hooks/[int hook_id]/deliveries
function get orgs/[string org]/hooks/[int hook_id]/deliveries(int per_page, string? cursor, boolean? redelivery) returns HookDeliveryItem[]|error
List deliveries for an organization webhook
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- cursor string? (default ()) - 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.
- redelivery boolean? (default ()) -
Return Type
- HookDeliveryItem[]|error - Response
get orgs/[string org]/hooks/[int hook_id]/deliveries/[int delivery_id]
function get orgs/[string org]/hooks/[int hook_id]/deliveries/[int delivery_id]() returns HookDelivery|error
Get a webhook delivery for an organization webhook
Return Type
- HookDelivery|error - Response
post orgs/[string org]/hooks/[int hook_id]/deliveries/[int delivery_id]/attempts
function post orgs/[string org]/hooks/[int hook_id]/deliveries/[int delivery_id]/attempts() returns json|error
Redeliver a delivery for an organization webhook
Return Type
- json|error - Accepted
post orgs/[string org]/hooks/[int hook_id]/pings
Ping an organization webhook
get orgs/[string org]/installation
function get orgs/[string org]/installation() returns Installation|error
Get an organization installation for the authenticated app
Return Type
- Installation|error - Response
get orgs/[string org]/installations
function get orgs/[string org]/installations(int per_page, int page) returns InstallationResponse|error
List app installations for an organization
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- InstallationResponse|error - Response
get orgs/[string org]/interaction-limits
function get orgs/[string org]/interaction\-limits() returns InteractionLimitResponseAny|error
Get interaction restrictions for an organization
Return Type
- InteractionLimitResponseAny|error - Response
put orgs/[string org]/interaction-limits
function put orgs/[string org]/interaction\-limits(InteractionLimit payload) returns InteractionLimitResponse|error
Set interaction restrictions for an organization
Parameters
- payload InteractionLimit -
Return Type
- InteractionLimitResponse|error - Response
delete orgs/[string org]/interaction-limits
function delete orgs/[string org]/interaction\-limits() returns error?
Remove interaction restrictions for an organization
Return Type
- error? - Response
get orgs/[string org]/invitations
function get orgs/[string org]/invitations(int per_page, int page, "all"|"admin"|"direct_member"|"billing_manager"|"hiring_manager" role, "all"|"member"|"scim" invitation_source) returns OrganizationInvitation[]|error
List pending organization invitations
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- role "all"|"admin"|"direct_member"|"billing_manager"|"hiring_manager" (default "all") - Filter invitations by their member role.
- invitation_source "all"|"member"|"scim" (default "all") - Filter invitations by their invitation source.
Return Type
- OrganizationInvitation[]|error - Response
post orgs/[string org]/invitations
function post orgs/[string org]/invitations(Org_invitations_body payload) returns OrganizationInvitation|error
Create an organization invitation
Parameters
- payload Org_invitations_body -
Return Type
- OrganizationInvitation|error - Response
delete orgs/[string org]/invitations/[int invitation_id]
Cancel an organization invitation
get orgs/[string org]/invitations/[int invitation_id]/teams
function get orgs/[string org]/invitations/[int invitation_id]/teams(int per_page, int page) returns Team[]|error
List organization invitation teams
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get orgs/[string org]/issues
function get orgs/[string org]/issues("assigned"|"created"|"mentioned"|"subscribed"|"repos"|"all" filter, "open"|"closed"|"all" state, string? labels, "created"|"updated"|"comments" sort, "asc"|"desc" direction, string? since, int per_page, int page) returns Issue[]|error
List organization issues assigned to the authenticated user
Parameters
- filter "assigned"|"created"|"mentioned"|"subscribed"|"repos"|"all" (default "assigned") - 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
orrepos
means all issues you can see, regardless of participation or creation.
- state "open"|"closed"|"all" (default "open") - Indicates the state of the issues to return.
- labels string? (default ()) - A list of comma separated label names. Example:
bug,ui,@high
- sort "created"|"updated"|"comments" (default "created") - What to sort results by.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get orgs/[string org]/members
function get orgs/[string org]/members("2fa_disabled"|"all" filter, "all"|"admin"|"member" role, int per_page, int page) returns SimpleUser[]|error
List organization members
Parameters
- filter "2fa_disabled"|"all" (default "all") - Filter members returned in the list.
2fa_disabled
means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners.
- role "all"|"admin"|"member" (default "all") - Filter members returned by their role.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get orgs/[string org]/members/[string username]
Check organization membership for a user
delete orgs/[string org]/members/[string username]
Remove an organization member
get orgs/[string org]/members/[string username]/codespaces
function get orgs/[string org]/members/[string username]/codespaces(int per_page, int page) returns CodespaceResponse|error
List codespaces for a user in organization
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CodespaceResponse|error - Response
delete orgs/[string org]/members/[string username]/codespaces/[string codespace_name]
function delete orgs/[string org]/members/[string username]/codespaces/[string codespace_name]() returns json|error
Delete a codespace from the organization
Return Type
- json|error - Accepted
post orgs/[string org]/members/[string username]/codespaces/[string codespace_name]/stop
function post orgs/[string org]/members/[string username]/codespaces/[string codespace_name]/stop() returns Codespace|error
Stop a codespace for an organization user
get orgs/[string org]/members/[string username]/copilot
function get orgs/[string org]/members/[string username]/copilot() returns CopilotSeatDetails|error
Get Copilot for Business seat assignment details for a user
Return Type
- CopilotSeatDetails|error - The user's GitHub Copilot seat details, including usage.
get orgs/[string org]/memberships/[string username]
function get orgs/[string org]/memberships/[string username]() returns OrgMembership|error
Get organization membership for a user
Return Type
- OrgMembership|error - Response
put orgs/[string org]/memberships/[string username]
function put orgs/[string org]/memberships/[string username](Memberships_username_body payload) returns OrgMembership|error
Set organization membership for a user
Parameters
- payload Memberships_username_body -
Return Type
- OrgMembership|error - Response
delete orgs/[string org]/memberships/[string username]
Remove organization membership for a user
get orgs/[string org]/migrations
function get orgs/[string org]/migrations(int per_page, int page, ("repositories")[]? exclude) returns Migration[]|error
List organization migrations
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- exclude ("repositories")[]? (default ()) - Exclude attributes from the API response to improve performance
post orgs/[string org]/migrations
function post orgs/[string org]/migrations(Org_migrations_body payload) returns Migration|error
Start an organization migration
Parameters
- payload Org_migrations_body -
get orgs/[string org]/migrations/[int migration_id]
function get orgs/[string org]/migrations/[int migration_id](("repositories")[]? exclude) returns Migration|error
Get an organization migration status
Parameters
- exclude ("repositories")[]? (default ()) - Exclude attributes from the API response to improve performance
Return Type
get orgs/[string org]/migrations/[int migration_id]/archive
Download an organization migration archive
delete orgs/[string org]/migrations/[int migration_id]/archive
Delete an organization migration archive
delete orgs/[string org]/migrations/[int migration_id]/repos/[string repo_name]/'lock
function delete orgs/[string org]/migrations/[int migration_id]/repos/[string repo_name]/'lock() returns Response|error
Unlock an organization repository
get orgs/[string org]/migrations/[int migration_id]/repositories
function get orgs/[string org]/migrations/[int migration_id]/repositories(int per_page, int page) returns MinimalRepository[]|error
List repositories in an organization migration
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Response
get orgs/[string org]/outside_collaborators
function get orgs/[string org]/outside_collaborators("2fa_disabled"|"all" filter, int per_page, int page) returns SimpleUser[]|error
List outside collaborators for an organization
Parameters
- filter "2fa_disabled"|"all" (default "all") - Filter the list of outside collaborators.
2fa_disabled
means that only outside collaborators without two-factor authentication enabled will be returned.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
put orgs/[string org]/outside_collaborators/[string username]
function put orgs/[string org]/outside_collaborators/[string username](Outside_collaborators_username_body payload) returns json|error
Convert an organization member to outside collaborator
Parameters
- payload Outside_collaborators_username_body -
Return Type
- json|error - User is getting converted asynchronously
delete orgs/[string org]/outside_collaborators/[string username]
Remove outside collaborator from an organization
get orgs/[string org]/packages
function get orgs/[string org]/packages("npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type, "public"|"private"|"internal"? visibility, int page, int per_page) returns Package[]|error
List packages for an organization
Parameters
- package_type "npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" - 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 typecontainer
. You can use the typedocker
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.
- visibility "public"|"private"|"internal"? (default ()) - The selected visibility of the packages. This parameter is optional and only filters an existing result set.
The
internal
visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystemsinternal
is synonymous withprivate
. For the list of GitHub Packages registries that support granular permissions, see "About permissions for GitHub Packages."
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
get orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]
function get orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]() returns Package|error
Get a package for an organization
delete orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]
function delete orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]() returns Response|error
Delete a package for an organization
post orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/restore
function post orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/restore(string? token) returns Response|error
Restore a package for an organization
Parameters
- token string? (default ()) - package token
get orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions
function get orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions(int page, int per_page, "active"|"deleted" state) returns PackageVersion[]|error
List package versions for a package owned by an organization
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
- state "active"|"deleted" (default "active") - The state of the package, either active or deleted.
Return Type
- PackageVersion[]|error - Response
get orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]
function get orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]() returns PackageVersion|error
Get a package version for an organization
Return Type
- PackageVersion|error - Response
delete orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]
function delete orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]() returns Response|error
Delete package version for an organization
post orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]/restore
function post orgs/[string org]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]/restore() returns Response|error
Restore package version for an organization
get orgs/[string org]/personal-access-token-requests
function get orgs/[string org]/personal\-access\-token\-requests(int per_page, int page, "created_at" sort, "asc"|"desc" direction, string[]? owner, string? repository, string? permission, string? last_used_before, string? last_used_after) returns OrganizationProgrammaticAccessGrantRequest[]|error
List requests to access organization resources with fine-grained personal access tokens
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- sort "created_at" (default "created_at") - The property by which to sort the results.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- owner string[]? (default ()) - A list of owner usernames to use to filter the results.
- repository string? (default ()) - The name of the repository to use to filter the results.
- permission string? (default ()) - The permission to use to filter the results.
Return Type
- OrganizationProgrammaticAccessGrantRequest[]|error - Internal Error
post orgs/[string org]/personal-access-token-requests
function post orgs/[string org]/personal\-access\-token\-requests(Org_personalaccesstokenrequests_body payload) returns json|error
Review requests to access organization resources with fine-grained personal access tokens
Parameters
- payload Org_personalaccesstokenrequests_body -
Return Type
- json|error - Internal Error
post orgs/[string org]/personal-access-token-requests/[int pat_request_id]
function post orgs/[string org]/personal\-access\-token\-requests/[int pat_request_id](Personalaccesstokenrequests_pat_request_id_body payload) returns error?
Review a request to access organization resources with a fine-grained personal access token
Parameters
Return Type
- error? - Internal Error
get orgs/[string org]/personal-access-token-requests/[int pat_request_id]/repositories
function get orgs/[string org]/personal\-access\-token\-requests/[int pat_request_id]/repositories(int per_page, int page) returns MinimalRepository[]|error
List repositories requested to be accessed by a fine-grained personal access token
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Internal Error
get orgs/[string org]/personal-access-tokens
function get orgs/[string org]/personal\-access\-tokens(int per_page, int page, "created_at" sort, "asc"|"desc" direction, string[]? owner, string? repository, string? permission, string? last_used_before, string? last_used_after) returns OrganizationProgrammaticAccessGrant[]|error
List fine-grained personal access tokens with access to organization resources
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- sort "created_at" (default "created_at") - The property by which to sort the results.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- owner string[]? (default ()) - A list of owner usernames to use to filter the results.
- repository string? (default ()) - The name of the repository to use to filter the results.
- permission string? (default ()) - The permission to use to filter the results.
Return Type
- OrganizationProgrammaticAccessGrant[]|error - Internal Error
post orgs/[string org]/personal-access-tokens
function post orgs/[string org]/personal\-access\-tokens(Org_personalaccesstokens_body payload) returns json|error
Update the access to organization resources via fine-grained personal access tokens
Parameters
- payload Org_personalaccesstokens_body -
Return Type
- json|error - Internal Error
post orgs/[string org]/personal-access-tokens/[int pat_id]
function post orgs/[string org]/personal\-access\-tokens/[int pat_id](Personalaccesstokens_pat_id_body payload) returns Response|error
Update the access a fine-grained personal access token has to organization resources
Parameters
- payload Personalaccesstokens_pat_id_body -
get orgs/[string org]/personal-access-tokens/[int pat_id]/repositories
function get orgs/[string org]/personal\-access\-tokens/[int pat_id]/repositories(int per_page, int page) returns MinimalRepository[]|error
List repositories a fine-grained personal access token has access to
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Internal Error
get orgs/[string org]/projects
function get orgs/[string org]/projects("open"|"closed"|"all" state, int per_page, int page) returns Project[]|error
List organization projects
Parameters
- state "open"|"closed"|"all" (default "open") - Indicates the state of the projects to return.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post orgs/[string org]/projects
function post orgs/[string org]/projects(Org_projects_body payload) returns Project|error
Create an organization project
Parameters
- payload Org_projects_body -
get orgs/[string org]/public_members
function get orgs/[string org]/public_members(int per_page, int page) returns SimpleUser[]|error
List public organization members
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get orgs/[string org]/public_members/[string username]
Check public organization membership for a user
put orgs/[string org]/public_members/[string username]
Set public organization membership for the authenticated user
delete orgs/[string org]/public_members/[string username]
function delete orgs/[string org]/public_members/[string username]() returns error?
Remove public organization membership for the authenticated user
Return Type
- error? - Response
get orgs/[string org]/repos
function get orgs/[string org]/repos("all"|"public"|"private"|"forks"|"sources"|"member" 'type, "created"|"updated"|"pushed"|"full_name" sort, "asc"|"desc"? direction, int per_page, int page) returns MinimalRepository[]|error
List organization repositories
Parameters
- 'type "all"|"public"|"private"|"forks"|"sources"|"member" (default "all") - Specifies the types of repositories you want returned.
- sort "created"|"updated"|"pushed"|"full_name" (default "created") - The property to sort the results by.
- direction "asc"|"desc"? (default ()) - The order to sort by. Default:
asc
when usingfull_name
, otherwisedesc
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Response
post orgs/[string org]/repos
function post orgs/[string org]/repos(Org_repos_body payload) returns Repository|error
Create an organization repository
Parameters
- payload Org_repos_body -
Return Type
- Repository|error - Response
get orgs/[string org]/rulesets
function get orgs/[string org]/rulesets(int per_page, int page) returns RepositoryRuleset[]|error
Get all organization repository rulesets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RepositoryRuleset[]|error - Response
post orgs/[string org]/rulesets
function post orgs/[string org]/rulesets(Org_rulesets_body payload) returns RepositoryRuleset|error
Create an organization repository ruleset
Parameters
- payload Org_rulesets_body - Request body
Return Type
- RepositoryRuleset|error - Response
get orgs/[string org]/rulesets/rule-suites
function get orgs/[string org]/rulesets/rule\-suites(int? repository_name, "hour"|"day"|"week"|"month" time_period, string? actor_name, "pass"|"fail"|"bypass"|"all" rule_suite_result, int per_page, int page) returns RuleSuites|error
List organization rule suites
Parameters
- repository_name int? (default ()) - The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned.
- time_period "hour"|"day"|"week"|"month" (default "day") - The time period to filter by.
For example,
day
will filter for rule suites that occurred in the past 24 hours, andweek
will filter for insights that occurred in the past 7 days (168 hours).
- actor_name string? (default ()) - The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.
- rule_suite_result "pass"|"fail"|"bypass"|"all" (default "all") - The rule results to filter on. When specified, only suites with this result will be returned.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RuleSuites|error - Response
get orgs/[string org]/rulesets/rule-suites/[int rule_suite_id]
Get an organization rule suite
get orgs/[string org]/rulesets/[int ruleset_id]
function get orgs/[string org]/rulesets/[int ruleset_id]() returns RepositoryRuleset|error
Get an organization repository ruleset
Return Type
- RepositoryRuleset|error - Response
put orgs/[string org]/rulesets/[int ruleset_id]
function put orgs/[string org]/rulesets/[int ruleset_id](Rulesets_ruleset_id_body payload) returns RepositoryRuleset|error
Update an organization repository ruleset
Parameters
- payload Rulesets_ruleset_id_body - Request body
Return Type
- RepositoryRuleset|error - Response
delete orgs/[string org]/rulesets/[int ruleset_id]
Delete an organization repository ruleset
get orgs/[string org]/secret-scanning/alerts
function get orgs/[string org]/secret\-scanning/alerts("open"|"resolved"? state, string? secret_type, string? resolution, "created"|"updated" sort, "asc"|"desc" direction, int page, int per_page, string? before, string? after) returns OrganizationSecretScanningAlert[]|error
List secret scanning alerts for an organization
Parameters
- state "open"|"resolved"? (default ()) - Set to
open
orresolved
to only list secret scanning alerts in a specific state.
- secret_type string? (default ()) - A comma-separated list of secret types to return. By default all secret types are returned. See "Secret scanning patterns" for a complete list of secret types.
- resolution string? (default ()) - 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
orused_in_tests
.
- sort "created"|"updated" (default "created") - The property to sort the results by.
created
means when the alert was created.updated
means when the alert was updated or resolved.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
- before string? (default ()) - A cursor, as given in the Link header. 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.
- after string? (default ()) - A cursor, as given in the Link header. 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.
Return Type
- OrganizationSecretScanningAlert[]|error - Response
get orgs/[string org]/security-advisories
function get orgs/[string org]/security\-advisories("asc"|"desc" direction, "created"|"updated"|"published" sort, string? before, string? after, int per_page, "triage"|"draft"|"published"|"closed"? state) returns RepositoryAdvisory[]|error
List repository security advisories for an organization
Parameters
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- sort "created"|"updated"|"published" (default "created") - The property to sort the results by.
- before string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
- after string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
- per_page int (default 30) - The number of advisories to return per page.
- state "triage"|"draft"|"published"|"closed"? (default ()) - Filter by the state of the repository advisories. Only advisories of this state will be returned.
Return Type
- RepositoryAdvisory[]|error - Response
get orgs/[string org]/security-managers
function get orgs/[string org]/security\-managers() returns TeamSimple[]|error
List security manager teams
Return Type
- TeamSimple[]|error - Response
put orgs/[string org]/security-managers/teams/[string team_slug]
Add a security manager team
delete orgs/[string org]/security-managers/teams/[string team_slug]
function delete orgs/[string org]/security\-managers/teams/[string team_slug]() returns error?
Remove a security manager team
Return Type
- error? - Response
get orgs/[string org]/settings/billing/actions
function get orgs/[string org]/settings/billing/actions() returns ActionsBillingUsage|error
Get GitHub Actions billing for an organization
Return Type
- ActionsBillingUsage|error - Response
get orgs/[string org]/settings/billing/packages
function get orgs/[string org]/settings/billing/packages() returns PackagesBillingUsage|error
Get GitHub Packages billing for an organization
Return Type
- PackagesBillingUsage|error - Response
get orgs/[string org]/settings/billing/shared-storage
function get orgs/[string org]/settings/billing/shared\-storage() returns CombinedBillingUsage|error
Get shared storage billing for an organization
Return Type
- CombinedBillingUsage|error - Response
get orgs/[string org]/teams
List teams
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post orgs/[string org]/teams
function post orgs/[string org]/teams(Org_teams_body payload) returns TeamFull|error
Create a team
Parameters
- payload Org_teams_body -
get orgs/[string org]/teams/[string team_slug]
Get a team by name
delete orgs/[string org]/teams/[string team_slug]
function delete orgs/[string org]/teams/[string team_slug]() returns error?
Delete a team
Return Type
- error? - Response
patch orgs/[string org]/teams/[string team_slug]
function patch orgs/[string org]/teams/[string team_slug](Teams_team_slug_body payload) returns TeamFull|error
Update a team
Parameters
- payload Teams_team_slug_body -
get orgs/[string org]/teams/[string team_slug]/discussions
function get orgs/[string org]/teams/[string team_slug]/discussions("asc"|"desc" direction, int per_page, int page, string? pinned) returns TeamDiscussion[]|error
List discussions
Parameters
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- pinned string? (default ()) - Pinned discussions only filter
Return Type
- TeamDiscussion[]|error - Response
post orgs/[string org]/teams/[string team_slug]/discussions
function post orgs/[string org]/teams/[string team_slug]/discussions(Team_slug_discussions_body payload) returns TeamDiscussion|error
Create a discussion
Parameters
- payload Team_slug_discussions_body -
Return Type
- TeamDiscussion|error - Response
get orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]
function get orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]() returns TeamDiscussion|error
Get a discussion
Return Type
- TeamDiscussion|error - Response
delete orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]
function delete orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]() returns error?
Delete a discussion
Return Type
- error? - Response
patch orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]
function patch orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number](Discussions_discussion_number_body payload) returns TeamDiscussion|error
Update a discussion
Parameters
- payload Discussions_discussion_number_body -
Return Type
- TeamDiscussion|error - Response
get orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments
function get orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments("asc"|"desc" direction, int per_page, int page) returns TeamDiscussionComment[]|error
List discussion comments
Parameters
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- TeamDiscussionComment[]|error - Response
post orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments
function post orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments(Discussion_number_comments_body payload) returns TeamDiscussionComment|error
Create a discussion comment
Parameters
- payload Discussion_number_comments_body -
Return Type
- TeamDiscussionComment|error - Response
get orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]
function get orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]() returns TeamDiscussionComment|error
Get a discussion comment
Return Type
- TeamDiscussionComment|error - Response
delete orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]
function delete orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]() returns error?
Delete a discussion comment
Return Type
- error? - Response
patch orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]
function patch orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number](Comments_comment_number_body payload) returns TeamDiscussionComment|error
Update a discussion comment
Parameters
- payload Comments_comment_number_body -
Return Type
- TeamDiscussionComment|error - Response
get orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]/reactions
function get orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]/reactions("+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? content, int per_page, int page) returns Reaction[]|error
List reactions for a team discussion comment
Parameters
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? (default ()) - Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]/reactions
function post orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]/reactions(Comment_number_reactions_body payload) returns Reaction|error
Create reaction for a team discussion comment
Parameters
- payload Comment_number_reactions_body -
Return Type
delete orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]/reactions/[int reaction_id]
function delete orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/comments/[int comment_number]/reactions/[int reaction_id]() returns error?
Delete team discussion comment reaction
Return Type
- error? - Response
get orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/reactions
function get orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/reactions("+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? content, int per_page, int page) returns Reaction[]|error
List reactions for a team discussion
Parameters
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? (default ()) - Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/reactions
function post orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/reactions(Discussion_number_reactions_body payload) returns Reaction|error
Create reaction for a team discussion
Parameters
- payload Discussion_number_reactions_body -
delete orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/reactions/[int reaction_id]
function delete orgs/[string org]/teams/[string team_slug]/discussions/[int discussion_number]/reactions/[int reaction_id]() returns error?
Delete team discussion reaction
Return Type
- error? - Response
get orgs/[string org]/teams/[string team_slug]/invitations
function get orgs/[string org]/teams/[string team_slug]/invitations(int per_page, int page) returns OrganizationInvitation[]|error
List pending team invitations
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- OrganizationInvitation[]|error - Response
get orgs/[string org]/teams/[string team_slug]/members
function get orgs/[string org]/teams/[string team_slug]/members("member"|"maintainer"|"all" role, int per_page, int page) returns SimpleUser[]|error
List team members
Parameters
- role "member"|"maintainer"|"all" (default "all") - Filters members returned by their role in the team.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get orgs/[string org]/teams/[string team_slug]/memberships/[string username]
function get orgs/[string org]/teams/[string team_slug]/memberships/[string username]() returns TeamMembership|error
Get team membership for a user
Return Type
- TeamMembership|error - Response
put orgs/[string org]/teams/[string team_slug]/memberships/[string username]
function put orgs/[string org]/teams/[string team_slug]/memberships/[string username](Memberships_username_body_1 payload) returns TeamMembership|error
Add or update team membership for a user
Parameters
- payload Memberships_username_body_1 -
Return Type
- TeamMembership|error - Response
delete orgs/[string org]/teams/[string team_slug]/memberships/[string username]
function delete orgs/[string org]/teams/[string team_slug]/memberships/[string username]() returns Response|error
Remove team membership for a user
get orgs/[string org]/teams/[string team_slug]/projects
function get orgs/[string org]/teams/[string team_slug]/projects(int per_page, int page) returns TeamProject[]|error
List team projects
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- TeamProject[]|error - Response
get orgs/[string org]/teams/[string team_slug]/projects/[int project_id]
function get orgs/[string org]/teams/[string team_slug]/projects/[int project_id]() returns TeamProject|error
Check team permissions for a project
Return Type
- TeamProject|error - Response
put orgs/[string org]/teams/[string team_slug]/projects/[int project_id]
function put orgs/[string org]/teams/[string team_slug]/projects/[int project_id](Projects_project_id_body payload) returns Response|error
Add or update team project permissions
Parameters
- payload Projects_project_id_body -
delete orgs/[string org]/teams/[string team_slug]/projects/[int project_id]
function delete orgs/[string org]/teams/[string team_slug]/projects/[int project_id]() returns error?
Remove a project from a team
Return Type
- error? - Response
get orgs/[string org]/teams/[string team_slug]/repos
function get orgs/[string org]/teams/[string team_slug]/repos(int per_page, int page) returns MinimalRepository[]|error
List team repositories
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Response
get orgs/[string org]/teams/[string team_slug]/repos/[string owner]/[string repo]
function get orgs/[string org]/teams/[string team_slug]/repos/[string owner]/[string repo]() returns TeamRepository|error
Check team permissions for a repository
Return Type
- TeamRepository|error - Alternative response with repository permissions
put orgs/[string org]/teams/[string team_slug]/repos/[string owner]/[string repo]
function put orgs/[string org]/teams/[string team_slug]/repos/[string owner]/[string repo](Owner_repo_body payload) returns error?
Add or update team repository permissions
Parameters
- payload Owner_repo_body -
Return Type
- error? - Response
delete orgs/[string org]/teams/[string team_slug]/repos/[string owner]/[string repo]
function delete orgs/[string org]/teams/[string team_slug]/repos/[string owner]/[string repo]() returns error?
Remove a repository from a team
Return Type
- error? - Response
get orgs/[string org]/teams/[string team_slug]/teams
function get orgs/[string org]/teams/[string team_slug]/teams(int per_page, int page) returns Team[]|error
List child teams
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post orgs/[string org]/["dependency_graph"|"dependabot_alerts"|"dependabot_security_updates"|"advanced_security"|"code_scanning_default_setup"|"secret_scanning"|"secret_scanning_push_protection" security_product]/["enable_all"|"disable_all" enablement]
function post orgs/[string org]/["dependency_graph"|"dependabot_alerts"|"dependabot_security_updates"|"advanced_security"|"code_scanning_default_setup"|"secret_scanning"|"secret_scanning_push_protection" security_product]/["enable_all"|"disable_all" enablement](Security_product_enablement_body payload) returns Response|error
Enable or disable a security feature for an organization
Parameters
- payload Security_product_enablement_body -
get projects/columns/cards/[int card_id]
function get projects/columns/cards/[int card_id]() returns ProjectCard|error
Get a project card
Return Type
- ProjectCard|error - Response
delete projects/columns/cards/[int card_id]
Delete a project card
patch projects/columns/cards/[int card_id]
function patch projects/columns/cards/[int card_id](Cards_card_id_body payload) returns ProjectCard|error
Update an existing project card
Parameters
- payload Cards_card_id_body -
Return Type
- ProjectCard|error - Response
post projects/columns/cards/[int card_id]/moves
function post projects/columns/cards/[int card_id]/moves(Card_id_moves_body payload) returns json|error
Move a project card
Parameters
- payload Card_id_moves_body -
Return Type
- json|error - Response
get projects/columns/[int column_id]
function get projects/columns/[int column_id]() returns ProjectColumn|error
Get a project column
Return Type
- ProjectColumn|error - Response
delete projects/columns/[int column_id]
Delete a project column
patch projects/columns/[int column_id]
function patch projects/columns/[int column_id](Columns_column_id_body payload) returns ProjectColumn|error
Update an existing project column
Parameters
- payload Columns_column_id_body -
Return Type
- ProjectColumn|error - Response
get projects/columns/[int column_id]/cards
function get projects/columns/[int column_id]/cards("all"|"archived"|"not_archived" archived_state, int per_page, int page) returns ProjectCard[]|error
List project cards
Parameters
- archived_state "all"|"archived"|"not_archived" (default "not_archived") - Filters the project cards that are returned by the card's state.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ProjectCard[]|error - Response
post projects/columns/[int column_id]/cards
function post projects/columns/[int column_id]/cards(Column_id_cards_body payload) returns ProjectCard|error
Create a project card
Parameters
- payload Column_id_cards_body -
Return Type
- ProjectCard|error - Response
post projects/columns/[int column_id]/moves
function post projects/columns/[int column_id]/moves(Column_id_moves_body payload) returns json|error
Move a project column
Parameters
- payload Column_id_moves_body -
Return Type
- json|error - Response
get projects/[int project_id]
Get a project
delete projects/[int project_id]
Delete a project
patch projects/[int project_id]
function patch projects/[int project_id](Projects_project_id_body_1 payload) returns Project|error
Update a project
Parameters
- payload Projects_project_id_body_1 -
get projects/[int project_id]/collaborators
function get projects/[int project_id]/collaborators("outside"|"direct"|"all" affiliation, int per_page, int page) returns SimpleUser[]|error
List project collaborators
Parameters
- affiliation "outside"|"direct"|"all" (default "all") - 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.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
put projects/[int project_id]/collaborators/[string username]
function put projects/[int project_id]/collaborators/[string username](Collaborators_username_body payload) returns Response|error
Add project collaborator
Parameters
- payload Collaborators_username_body -
delete projects/[int project_id]/collaborators/[string username]
Remove user as a collaborator
get projects/[int project_id]/collaborators/[string username]/permission
function get projects/[int project_id]/collaborators/[string username]/permission() returns ProjectCollaboratorPermission|error
Get project permission for a user
Return Type
- ProjectCollaboratorPermission|error - Response
get projects/[int project_id]/columns
function get projects/[int project_id]/columns(int per_page, int page) returns ProjectColumn[]|error
List project columns
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ProjectColumn[]|error - Response
post projects/[int project_id]/columns
function post projects/[int project_id]/columns(Project_id_columns_body payload) returns ProjectColumn|error
Create a project column
Parameters
- payload Project_id_columns_body -
Return Type
- ProjectColumn|error - Response
get rate_limit
function get rate_limit() returns RateLimitOverview|error
Get rate limit status for the authenticated user
Return Type
- RateLimitOverview|error - Response
get repos/[string owner]/[string repo]
function get repos/[string owner]/[string repo]() returns FullRepository|error
Get a repository
Return Type
- FullRepository|error - Response
delete repos/[string owner]/[string repo]
Delete a repository
patch repos/[string owner]/[string repo]
function patch repos/[string owner]/[string repo](Owner_repo_body_1 payload) returns FullRepository|error
Update a repository
Parameters
- payload Owner_repo_body_1 -
Return Type
- FullRepository|error - Response
get repos/[string owner]/[string repo]/actions/artifacts
function get repos/[string owner]/[string repo]/actions/artifacts(int per_page, int page, string? name) returns ArtifactResponse|error
List artifacts for a repository
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- name string? (default ()) - The name field of an artifact. When specified, only artifacts with this name will be returned.
Return Type
- ArtifactResponse|error - Response
get repos/[string owner]/[string repo]/actions/artifacts/[int artifact_id]
function get repos/[string owner]/[string repo]/actions/artifacts/[int artifact_id]() returns Artifact|error
Get an artifact
delete repos/[string owner]/[string repo]/actions/artifacts/[int artifact_id]
function delete repos/[string owner]/[string repo]/actions/artifacts/[int artifact_id]() returns error?
Delete an artifact
Return Type
- error? - Response
get repos/[string owner]/[string repo]/actions/artifacts/[int artifact_id]/[string archive_format]
function get repos/[string owner]/[string repo]/actions/artifacts/[int artifact_id]/[string archive_format]() returns Response|error
Download an artifact
get repos/[string owner]/[string repo]/actions/cache/usage
function get repos/[string owner]/[string repo]/actions/cache/usage() returns ActionsCacheUsageByRepository|error
Get GitHub Actions cache usage for a repository
Return Type
- ActionsCacheUsageByRepository|error - Response
get repos/[string owner]/[string repo]/actions/caches
function get repos/[string owner]/[string repo]/actions/caches(int per_page, int page, string? ref, string? 'key, "created_at"|"last_accessed_at"|"size_in_bytes" sort, "asc"|"desc" direction) returns ActionsCacheList|error
List GitHub Actions caches for a repository
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- ref string? (default ()) - The full Git reference for narrowing down the cache. The
ref
for a branch should be formatted asrefs/heads/<branch name>
. To reference a pull request userefs/pull/<number>/merge
.
- 'key string? (default ()) - An explicit key or prefix for identifying the cache
- sort "created_at"|"last_accessed_at"|"size_in_bytes" (default "last_accessed_at") - 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.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
Return Type
- ActionsCacheList|error - Response
delete repos/[string owner]/[string repo]/actions/caches
function delete repos/[string owner]/[string repo]/actions/caches(string 'key, string? ref) returns ActionsCacheList|error
Delete GitHub Actions caches for a repository (using a cache key)
Parameters
- 'key string - A key for identifying the cache.
- ref string? (default ()) - The full Git reference for narrowing down the cache. The
ref
for a branch should be formatted asrefs/heads/<branch name>
. To reference a pull request userefs/pull/<number>/merge
.
Return Type
- ActionsCacheList|error - Response
delete repos/[string owner]/[string repo]/actions/caches/[int cache_id]
function delete repos/[string owner]/[string repo]/actions/caches/[int cache_id]() returns error?
Delete a GitHub Actions cache for a repository (using a cache ID)
Return Type
- error? - Response
get repos/[string owner]/[string repo]/actions/jobs/[int job_id]
Get a job for a workflow run
get repos/[string owner]/[string repo]/actions/jobs/[int job_id]/logs
function get repos/[string owner]/[string repo]/actions/jobs/[int job_id]/logs() returns error?
Download job logs for a workflow run
Return Type
- error? - Response
post repos/[string owner]/[string repo]/actions/jobs/[int job_id]/rerun
function post repos/[string owner]/[string repo]/actions/jobs/[int job_id]/rerun(Job_id_rerun_body payload) returns EmptyObject|error
Re-run a job from a workflow run
Parameters
- payload Job_id_rerun_body -
Return Type
- EmptyObject|error - Response
get repos/[string owner]/[string repo]/actions/oidc/customization/sub
function get repos/[string owner]/[string repo]/actions/oidc/customization/sub() returns OidcCustomSubRepo|error
Get the customization template for an OIDC subject claim for a repository
Return Type
- OidcCustomSubRepo|error - Status response
put repos/[string owner]/[string repo]/actions/oidc/customization/sub
function put repos/[string owner]/[string repo]/actions/oidc/customization/sub(ActionsOidcSubjectCustomizationForARepository payload) returns EmptyObject|error
Set the customization template for an OIDC subject claim for a repository
Parameters
Return Type
- EmptyObject|error - Empty response
get repos/[string owner]/[string repo]/actions/organization-secrets
function get repos/[string owner]/[string repo]/actions/organization\-secrets(int per_page, int page) returns ActionsSecretResponse|error
List repository organization secrets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ActionsSecretResponse|error - Response
get repos/[string owner]/[string repo]/actions/organization-variables
function get repos/[string owner]/[string repo]/actions/organization\-variables(int per_page, int page) returns ActionsVariableResponse|error
List repository organization variables
Parameters
- per_page int (default 10) - The number of results per page (max 30).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ActionsVariableResponse|error - Response
get repos/[string owner]/[string repo]/actions/permissions
function get repos/[string owner]/[string repo]/actions/permissions() returns ActionsRepositoryPermissions|error
Get GitHub Actions permissions for a repository
Return Type
- ActionsRepositoryPermissions|error - Response
put repos/[string owner]/[string repo]/actions/permissions
function put repos/[string owner]/[string repo]/actions/permissions(Actions_permissions_body_1 payload) returns error?
Set GitHub Actions permissions for a repository
Parameters
- payload Actions_permissions_body_1 -
Return Type
- error? - Response
get repos/[string owner]/[string repo]/actions/permissions/access
function get repos/[string owner]/[string repo]/actions/permissions/access() returns ActionsWorkflowAccessToRepository|error
Get the level of access for workflows outside of the repository
Return Type
- ActionsWorkflowAccessToRepository|error - Response
put repos/[string owner]/[string repo]/actions/permissions/access
function put repos/[string owner]/[string repo]/actions/permissions/access(ActionsWorkflowAccessToRepository payload) returns error?
Set the level of access for workflows outside of the repository
Parameters
- payload ActionsWorkflowAccessToRepository -
Return Type
- error? - Response
get repos/[string owner]/[string repo]/actions/permissions/selected-actions
function get repos/[string owner]/[string repo]/actions/permissions/selected\-actions() returns SelectedActions|error
Get allowed actions and reusable workflows for a repository
Return Type
- SelectedActions|error - Response
put repos/[string owner]/[string repo]/actions/permissions/selected-actions
function put repos/[string owner]/[string repo]/actions/permissions/selected\-actions(SelectedActions payload) returns error?
Set allowed actions and reusable workflows for a repository
Parameters
- payload SelectedActions -
Return Type
- error? - Response
get repos/[string owner]/[string repo]/actions/permissions/workflow
function get repos/[string owner]/[string repo]/actions/permissions/workflow() returns ActionsGetDefaultWorkflowPermissions|error
Get default workflow permissions for a repository
Return Type
- ActionsGetDefaultWorkflowPermissions|error - Response
put repos/[string owner]/[string repo]/actions/permissions/workflow
function put repos/[string owner]/[string repo]/actions/permissions/workflow(ActionsSetDefaultWorkflowPermissions payload) returns Response|error
Set default workflow permissions for a repository
Parameters
- payload ActionsSetDefaultWorkflowPermissions -
get repos/[string owner]/[string repo]/actions/runners
function get repos/[string owner]/[string repo]/actions/runners(string? name, int per_page, int page) returns RunnerResponse|error
List self-hosted runners for a repository
Parameters
- name string? (default ()) - The name of a self-hosted runner.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RunnerResponse|error - Response
get repos/[string owner]/[string repo]/actions/runners/downloads
function get repos/[string owner]/[string repo]/actions/runners/downloads() returns RunnerApplication[]|error
List runner applications for a repository
Return Type
- RunnerApplication[]|error - Response
post repos/[string owner]/[string repo]/actions/runners/generate-jitconfig
function post repos/[string owner]/[string repo]/actions/runners/generate\-jitconfig(Runners_generatejitconfig_body_1 payload) returns JitConfig|error
Create configuration for a just-in-time runner for a repository
Parameters
- payload Runners_generatejitconfig_body_1 -
post repos/[string owner]/[string repo]/actions/runners/registration-token
function post repos/[string owner]/[string repo]/actions/runners/registration\-token() returns AuthenticationToken|error
Create a registration token for a repository
Return Type
- AuthenticationToken|error - Response
post repos/[string owner]/[string repo]/actions/runners/remove-token
function post repos/[string owner]/[string repo]/actions/runners/remove\-token() returns AuthenticationToken|error
Create a remove token for a repository
Return Type
- AuthenticationToken|error - Response
get repos/[string owner]/[string repo]/actions/runners/[int runner_id]
function get repos/[string owner]/[string repo]/actions/runners/[int runner_id]() returns Runner|error
Get a self-hosted runner for a repository
delete repos/[string owner]/[string repo]/actions/runners/[int runner_id]
function delete repos/[string owner]/[string repo]/actions/runners/[int runner_id]() returns error?
Delete a self-hosted runner from a repository
Return Type
- error? - Response
get repos/[string owner]/[string repo]/actions/runners/[int runner_id]/labels
function get repos/[string owner]/[string repo]/actions/runners/[int runner_id]/labels() returns RunnerLabelResponse|error
List labels for a self-hosted runner for a repository
Return Type
- RunnerLabelResponse|error - Response
put repos/[string owner]/[string repo]/actions/runners/[int runner_id]/labels
function put repos/[string owner]/[string repo]/actions/runners/[int runner_id]/labels(Runner_id_labels_body_2 payload) returns RunnerLabelResponse|error
Set custom labels for a self-hosted runner for a repository
Parameters
- payload Runner_id_labels_body_2 -
Return Type
- RunnerLabelResponse|error - Response
post repos/[string owner]/[string repo]/actions/runners/[int runner_id]/labels
function post repos/[string owner]/[string repo]/actions/runners/[int runner_id]/labels(Runner_id_labels_body_3 payload) returns RunnerLabelResponse|error
Add custom labels to a self-hosted runner for a repository
Parameters
- payload Runner_id_labels_body_3 -
Return Type
- RunnerLabelResponse|error - Response
delete repos/[string owner]/[string repo]/actions/runners/[int runner_id]/labels
function delete repos/[string owner]/[string repo]/actions/runners/[int runner_id]/labels() returns RunnerLabelResponse|error
Remove all custom labels from a self-hosted runner for a repository
Return Type
- RunnerLabelResponse|error - Response
delete repos/[string owner]/[string repo]/actions/runners/[int runner_id]/labels/[string name]
function delete repos/[string owner]/[string repo]/actions/runners/[int runner_id]/labels/[string name]() returns RunnerLabelResponse|error
Remove a custom label from a self-hosted runner for a repository
Return Type
- RunnerLabelResponse|error - Response
get repos/[string owner]/[string repo]/actions/runs
function get repos/[string owner]/[string repo]/actions/runs(string? actor, string? branch, string? event, "completed"|"action_required"|"cancelled"|"failure"|"neutral"|"skipped"|"stale"|"success"|"timed_out"|"in_progress"|"queued"|"requested"|"waiting"|"pending"? status, int per_page, int page, string? created, boolean exclude_pull_requests, int? check_suite_id, string? head_sha) returns WorkflowRunResponse|error
List workflow runs for a repository
Parameters
- actor string? (default ()) - Returns someone's workflow runs. Use the login for the user who created the
push
associated with the check suite or workflow run.
- branch string? (default ()) - Returns workflow runs associated with a branch. Use the name of the branch of the
push
.
- event string? (default ()) - Returns workflow run triggered by the event you specify. For example,
push
,pull_request
orissue
. For more information, see "Events that trigger workflows."
- status "completed"|"action_required"|"cancelled"|"failure"|"neutral"|"skipped"|"stale"|"success"|"timed_out"|"in_progress"|"queued"|"requested"|"waiting"|"pending"? (default ()) - Returns workflow runs with the check run
status
orconclusion
that you specify. For example, a conclusion can besuccess
or a status can bein_progress
. Only GitHub can set a status ofwaiting
orrequested
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- created string? (default ()) - Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
- exclude_pull_requests boolean (default false) - If
true
pull requests are omitted from the response (empty array).
- check_suite_id int? (default ()) - Returns workflow runs with the
check_suite_id
that you specify.
- head_sha string? (default ()) - Only returns workflow runs that are associated with the specified
head_sha
.
Return Type
- WorkflowRunResponse|error - Response
get repos/[string owner]/[string repo]/actions/runs/[int run_id]
function get repos/[string owner]/[string repo]/actions/runs/[int run_id](boolean exclude_pull_requests) returns WorkflowRun|error
Get a workflow run
Parameters
- exclude_pull_requests boolean (default false) - If
true
pull requests are omitted from the response (empty array).
Return Type
- WorkflowRun|error - Response
delete repos/[string owner]/[string repo]/actions/runs/[int run_id]
function delete repos/[string owner]/[string repo]/actions/runs/[int run_id]() returns error?
Delete a workflow run
Return Type
- error? - Response
get repos/[string owner]/[string repo]/actions/runs/[int run_id]/approvals
function get repos/[string owner]/[string repo]/actions/runs/[int run_id]/approvals() returns EnvironmentApprovals[]|error
Get the review history for a workflow run
Return Type
- EnvironmentApprovals[]|error - Response
post repos/[string owner]/[string repo]/actions/runs/[int run_id]/approve
function post repos/[string owner]/[string repo]/actions/runs/[int run_id]/approve() returns EmptyObject|error
Approve a workflow run for a fork pull request
Return Type
- EmptyObject|error - Response
get repos/[string owner]/[string repo]/actions/runs/[int run_id]/artifacts
function get repos/[string owner]/[string repo]/actions/runs/[int run_id]/artifacts(int per_page, int page, string? name) returns ArtifactResponse|error
List workflow run artifacts
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- name string? (default ()) - The name field of an artifact. When specified, only artifacts with this name will be returned.
Return Type
- ArtifactResponse|error - Response
get repos/[string owner]/[string repo]/actions/runs/[int run_id]/attempts/[int attempt_number]
function get repos/[string owner]/[string repo]/actions/runs/[int run_id]/attempts/[int attempt_number](boolean exclude_pull_requests) returns WorkflowRun|error
Get a workflow run attempt
Parameters
- exclude_pull_requests boolean (default false) - If
true
pull requests are omitted from the response (empty array).
Return Type
- WorkflowRun|error - Response
get repos/[string owner]/[string repo]/actions/runs/[int run_id]/attempts/[int attempt_number]/jobs
function get repos/[string owner]/[string repo]/actions/runs/[int run_id]/attempts/[int attempt_number]/jobs(int per_page, int page) returns JobResponse|error
List jobs for a workflow run attempt
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- JobResponse|error - Response
get repos/[string owner]/[string repo]/actions/runs/[int run_id]/attempts/[int attempt_number]/logs
function get repos/[string owner]/[string repo]/actions/runs/[int run_id]/attempts/[int attempt_number]/logs() returns error?
Download workflow run attempt logs
Return Type
- error? - Response
post repos/[string owner]/[string repo]/actions/runs/[int run_id]/cancel
function post repos/[string owner]/[string repo]/actions/runs/[int run_id]/cancel() returns EmptyObject|error
Cancel a workflow run
Return Type
- EmptyObject|error - Response
post repos/[string owner]/[string repo]/actions/runs/[int run_id]/deployment_protection_rule
function post repos/[string owner]/[string repo]/actions/runs/[int run_id]/deployment_protection_rule(Run_id_deployment_protection_rule_body payload) returns error?
Review custom deployment protection rules for a workflow run
Parameters
- payload Run_id_deployment_protection_rule_body -
Return Type
- error? - Response
post repos/[string owner]/[string repo]/actions/runs/[int run_id]/force-cancel
function post repos/[string owner]/[string repo]/actions/runs/[int run_id]/force\-cancel() returns EmptyObject|error
Force cancel a workflow run
Return Type
- EmptyObject|error - Response
get repos/[string owner]/[string repo]/actions/runs/[int run_id]/jobs
function get repos/[string owner]/[string repo]/actions/runs/[int run_id]/jobs("latest"|"all" filter, int per_page, int page) returns JobResponse|error
List jobs for a workflow run
Parameters
- filter "latest"|"all" (default "latest") - 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.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- JobResponse|error - Response
get repos/[string owner]/[string repo]/actions/runs/[int run_id]/logs
function get repos/[string owner]/[string repo]/actions/runs/[int run_id]/logs() returns error?
Download workflow run logs
Return Type
- error? - Response
delete repos/[string owner]/[string repo]/actions/runs/[int run_id]/logs
function delete repos/[string owner]/[string repo]/actions/runs/[int run_id]/logs() returns Response|error
Delete workflow run logs
get repos/[string owner]/[string repo]/actions/runs/[int run_id]/pending_deployments
function get repos/[string owner]/[string repo]/actions/runs/[int run_id]/pending_deployments() returns PendingDeployment[]|error
Get pending deployments for a workflow run
Return Type
- PendingDeployment[]|error - Response
post repos/[string owner]/[string repo]/actions/runs/[int run_id]/pending_deployments
function post repos/[string owner]/[string repo]/actions/runs/[int run_id]/pending_deployments(Run_id_pending_deployments_body payload) returns Deployment[]|error
Review pending deployments for a workflow run
Parameters
- payload Run_id_pending_deployments_body -
Return Type
- Deployment[]|error - Response
post repos/[string owner]/[string repo]/actions/runs/[int run_id]/rerun
function post repos/[string owner]/[string repo]/actions/runs/[int run_id]/rerun(Run_id_rerun_body payload) returns EmptyObject|error
Re-run a workflow
Parameters
- payload Run_id_rerun_body -
Return Type
- EmptyObject|error - Response
post repos/[string owner]/[string repo]/actions/runs/[int run_id]/rerun-failed-jobs
function post repos/[string owner]/[string repo]/actions/runs/[int run_id]/rerun\-failed\-jobs(Run_id_rerunfailedjobs_body payload) returns EmptyObject|error
Re-run failed jobs from a workflow run
Parameters
- payload Run_id_rerunfailedjobs_body -
Return Type
- EmptyObject|error - Response
get repos/[string owner]/[string repo]/actions/runs/[int run_id]/timing
function get repos/[string owner]/[string repo]/actions/runs/[int run_id]/timing() returns WorkflowRunUsage|error
Get workflow run usage
Return Type
- WorkflowRunUsage|error - Response
get repos/[string owner]/[string repo]/actions/secrets
function get repos/[string owner]/[string repo]/actions/secrets(int per_page, int page) returns ActionsSecretResponse|error
List repository secrets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ActionsSecretResponse|error - Response
get repos/[string owner]/[string repo]/actions/secrets/public-key
function get repos/[string owner]/[string repo]/actions/secrets/public\-key() returns ActionsPublicKey|error
Get a repository public key
Return Type
- ActionsPublicKey|error - Response
get repos/[string owner]/[string repo]/actions/secrets/[string secret_name]
function get repos/[string owner]/[string repo]/actions/secrets/[string secret_name]() returns ActionsSecret|error
Get a repository secret
Return Type
- ActionsSecret|error - Response
put repos/[string owner]/[string repo]/actions/secrets/[string secret_name]
function put repos/[string owner]/[string repo]/actions/secrets/[string secret_name](Secrets_secret_name_body_3 payload) returns EmptyObject|error?
Create or update a repository secret
Parameters
- payload Secrets_secret_name_body_3 -
Return Type
- EmptyObject|error? - Response when creating a secret
delete repos/[string owner]/[string repo]/actions/secrets/[string secret_name]
function delete repos/[string owner]/[string repo]/actions/secrets/[string secret_name]() returns error?
Delete a repository secret
Return Type
- error? - Response
get repos/[string owner]/[string repo]/actions/variables
function get repos/[string owner]/[string repo]/actions/variables(int per_page, int page) returns ActionsVariableResponse|error
List repository variables
Parameters
- per_page int (default 10) - The number of results per page (max 30).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ActionsVariableResponse|error - Response
post repos/[string owner]/[string repo]/actions/variables
function post repos/[string owner]/[string repo]/actions/variables(Actions_variables_body_1 payload) returns EmptyObject|error
Create a repository variable
Parameters
- payload Actions_variables_body_1 -
Return Type
- EmptyObject|error - Response
get repos/[string owner]/[string repo]/actions/variables/[string name]
function get repos/[string owner]/[string repo]/actions/variables/[string name]() returns ActionsVariable|error
Get a repository variable
Return Type
- ActionsVariable|error - Response
delete repos/[string owner]/[string repo]/actions/variables/[string name]
function delete repos/[string owner]/[string repo]/actions/variables/[string name]() returns error?
Delete a repository variable
Return Type
- error? - Response
patch repos/[string owner]/[string repo]/actions/variables/[string name]
function patch repos/[string owner]/[string repo]/actions/variables/[string name](Variables_name_body_1 payload) returns error?
Update a repository variable
Parameters
- payload Variables_name_body_1 -
Return Type
- error? - Response
get repos/[string owner]/[string repo]/actions/workflows
function get repos/[string owner]/[string repo]/actions/workflows(int per_page, int page) returns WorkflowResponse|error
List repository workflows
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- WorkflowResponse|error - Response
get repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]
function get repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]() returns Workflow|error
Get a workflow
put repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]/disable
function put repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]/disable() returns error?
Disable a workflow
Return Type
- error? - Response
post repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]/dispatches
function post repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]/dispatches(Workflow_id_dispatches_body payload) returns error?
Create a workflow dispatch event
Parameters
- payload Workflow_id_dispatches_body -
Return Type
- error? - Response
put repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]/enable
function put repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]/enable() returns error?
Enable a workflow
Return Type
- error? - Response
get repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]/runs
function get repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]/runs(string? actor, string? branch, string? event, "completed"|"action_required"|"cancelled"|"failure"|"neutral"|"skipped"|"stale"|"success"|"timed_out"|"in_progress"|"queued"|"requested"|"waiting"|"pending"? status, int per_page, int page, string? created, boolean exclude_pull_requests, int? check_suite_id, string? head_sha) returns WorkflowRunResponse|error
List workflow runs for a workflow
Parameters
- actor string? (default ()) - Returns someone's workflow runs. Use the login for the user who created the
push
associated with the check suite or workflow run.
- branch string? (default ()) - Returns workflow runs associated with a branch. Use the name of the branch of the
push
.
- event string? (default ()) - Returns workflow run triggered by the event you specify. For example,
push
,pull_request
orissue
. For more information, see "Events that trigger workflows."
- status "completed"|"action_required"|"cancelled"|"failure"|"neutral"|"skipped"|"stale"|"success"|"timed_out"|"in_progress"|"queued"|"requested"|"waiting"|"pending"? (default ()) - Returns workflow runs with the check run
status
orconclusion
that you specify. For example, a conclusion can besuccess
or a status can bein_progress
. Only GitHub can set a status ofwaiting
orrequested
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- created string? (default ()) - Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
- exclude_pull_requests boolean (default false) - If
true
pull requests are omitted from the response (empty array).
- check_suite_id int? (default ()) - Returns workflow runs with the
check_suite_id
that you specify.
- head_sha string? (default ()) - Only returns workflow runs that are associated with the specified
head_sha
.
Return Type
- WorkflowRunResponse|error - Response
get repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]/timing
function get repos/[string owner]/[string repo]/actions/workflows/[Workflow_id workflow_id]/timing() returns WorkflowUsage|error
Get workflow usage
Return Type
- WorkflowUsage|error - Response
get repos/[string owner]/[string repo]/activity
function get repos/[string owner]/[string repo]/activity("asc"|"desc" direction, int per_page, string? before, string? after, string? ref, string? actor, "day"|"week"|"month"|"quarter"|"year"? time_period, "push"|"force_push"|"branch_creation"|"branch_deletion"|"pr_merge"|"merge_queue_merge"? activity_type) returns Activity[]|error
List repository activities
Parameters
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- before string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
- after string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
- ref string? (default ()) - The Git reference for the activities you want to list.
The
ref
for a branch can be formatted either asrefs/heads/BRANCH_NAME
orBRANCH_NAME
, whereBRANCH_NAME
is the name of your branch.
- actor string? (default ()) - The GitHub username to use to filter by the actor who performed the activity.
- time_period "day"|"week"|"month"|"quarter"|"year"? (default ()) - The time period to filter by.
For example,
day
will filter for activity that occurred in the past 24 hours, andweek
will filter for activity that occurred in the past 7 days (168 hours).
- activity_type "push"|"force_push"|"branch_creation"|"branch_deletion"|"pr_merge"|"merge_queue_merge"? (default ()) - The activity type to filter by. For example, you can choose to filter by "force_push", to see all force pushes to the repository.
get repos/[string owner]/[string repo]/assignees
function get repos/[string owner]/[string repo]/assignees(int per_page, int page) returns SimpleUser[]|error
List assignees
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get repos/[string owner]/[string repo]/assignees/[string assignee]
function get repos/[string owner]/[string repo]/assignees/[string assignee]() returns Response|error
Check if a user can be assigned
Return Type
get repos/[string owner]/[string repo]/autolinks
List all autolinks of a repository
Parameters
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/autolinks
function post repos/[string owner]/[string repo]/autolinks(Repo_autolinks_body payload) returns Autolink|error
Create an autolink reference for a repository
Parameters
- payload Repo_autolinks_body -
get repos/[string owner]/[string repo]/autolinks/[int autolink_id]
function get repos/[string owner]/[string repo]/autolinks/[int autolink_id]() returns Autolink|error
Get an autolink reference of a repository
delete repos/[string owner]/[string repo]/autolinks/[int autolink_id]
function delete repos/[string owner]/[string repo]/autolinks/[int autolink_id]() returns Response|error
Delete an autolink reference from a repository
get repos/[string owner]/[string repo]/automated-security-fixes
function get repos/[string owner]/[string repo]/automated\-security\-fixes() returns CheckAutomatedSecurityFixes|error
Check if automated security fixes are enabled for a repository
Return Type
- CheckAutomatedSecurityFixes|error - Response if dependabot is enabled
put repos/[string owner]/[string repo]/automated-security-fixes
function put repos/[string owner]/[string repo]/automated\-security\-fixes() returns error?
Enable automated security fixes
Return Type
- error? - Response
delete repos/[string owner]/[string repo]/automated-security-fixes
function delete repos/[string owner]/[string repo]/automated\-security\-fixes() returns error?
Disable automated security fixes
Return Type
- error? - Response
get repos/[string owner]/[string repo]/branches
function get repos/[string owner]/[string repo]/branches(boolean? protected, int per_page, int page) returns ShortBranch[]|error
List branches
Parameters
- protected boolean? (default ()) - Setting to
true
returns only protected branches. When set tofalse
, only unprotected branches are returned. Omitting this parameter returns all branches.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ShortBranch[]|error - Response
get repos/[string owner]/[string repo]/branches/[string branch]
function get repos/[string owner]/[string repo]/branches/[string branch]() returns BranchWithProtection|error
Get a branch
Return Type
- BranchWithProtection|error - Response
get repos/[string owner]/[string repo]/branches/[string branch]/protection
function get repos/[string owner]/[string repo]/branches/[string branch]/protection() returns BranchProtection|error
Get branch protection
Return Type
- BranchProtection|error - Response
put repos/[string owner]/[string repo]/branches/[string branch]/protection
function put repos/[string owner]/[string repo]/branches/[string branch]/protection(Branch_protection_body payload) returns ProtectedBranch|error
Update branch protection
Parameters
- payload Branch_protection_body -
Return Type
- ProtectedBranch|error - Response
delete repos/[string owner]/[string repo]/branches/[string branch]/protection
function delete repos/[string owner]/[string repo]/branches/[string branch]/protection() returns Response|error
Delete branch protection
get repos/[string owner]/[string repo]/branches/[string branch]/protection/enforce_admins
function get repos/[string owner]/[string repo]/branches/[string branch]/protection/enforce_admins() returns ProtectedBranchAdminEnforced|error
Get admin branch protection
Return Type
- ProtectedBranchAdminEnforced|error - Response
post repos/[string owner]/[string repo]/branches/[string branch]/protection/enforce_admins
function post repos/[string owner]/[string repo]/branches/[string branch]/protection/enforce_admins() returns ProtectedBranchAdminEnforced|error
Set admin branch protection
Return Type
- ProtectedBranchAdminEnforced|error - Response
delete repos/[string owner]/[string repo]/branches/[string branch]/protection/enforce_admins
function delete repos/[string owner]/[string repo]/branches/[string branch]/protection/enforce_admins() returns Response|error
Delete admin branch protection
get repos/[string owner]/[string repo]/branches/[string branch]/protection/required_pull_request_reviews
function get repos/[string owner]/[string repo]/branches/[string branch]/protection/required_pull_request_reviews() returns ProtectedBranchPullRequestReview|error
Get pull request review protection
Return Type
- ProtectedBranchPullRequestReview|error - Response
delete repos/[string owner]/[string repo]/branches/[string branch]/protection/required_pull_request_reviews
function delete repos/[string owner]/[string repo]/branches/[string branch]/protection/required_pull_request_reviews() returns Response|error
Delete pull request review protection
patch repos/[string owner]/[string repo]/branches/[string branch]/protection/required_pull_request_reviews
function patch repos/[string owner]/[string repo]/branches/[string branch]/protection/required_pull_request_reviews(Protection_required_pull_request_reviews_body payload) returns ProtectedBranchPullRequestReview|error
Update pull request review protection
Parameters
Return Type
- ProtectedBranchPullRequestReview|error - Response
get repos/[string owner]/[string repo]/branches/[string branch]/protection/required_signatures
function get repos/[string owner]/[string repo]/branches/[string branch]/protection/required_signatures() returns ProtectedBranchAdminEnforced|error
Get commit signature protection
Return Type
- ProtectedBranchAdminEnforced|error - Response
post repos/[string owner]/[string repo]/branches/[string branch]/protection/required_signatures
function post repos/[string owner]/[string repo]/branches/[string branch]/protection/required_signatures() returns ProtectedBranchAdminEnforced|error
Create commit signature protection
Return Type
- ProtectedBranchAdminEnforced|error - Response
delete repos/[string owner]/[string repo]/branches/[string branch]/protection/required_signatures
function delete repos/[string owner]/[string repo]/branches/[string branch]/protection/required_signatures() returns Response|error
Delete commit signature protection
get repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks
function get repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks() returns StatusCheckPolicy|error
Get status checks protection
Return Type
- StatusCheckPolicy|error - Response
delete repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks
function delete repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks() returns error?
Remove status check protection
Return Type
- error? - Response
patch repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks
function patch repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks(Protection_required_status_checks_body payload) returns StatusCheckPolicy|error
Update status check protection
Parameters
- payload Protection_required_status_checks_body -
Return Type
- StatusCheckPolicy|error - Response
get repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks/contexts
function get repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks/contexts() returns string[]|error
Get all status check contexts
put repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks/contexts
function put repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks/contexts(Required_status_checks_contexts_body payload) returns string[]|error
Set status check contexts
Parameters
- payload Required_status_checks_contexts_body -
post repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks/contexts
function post repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks/contexts(Required_status_checks_contexts_body_1 payload) returns string[]|error
Add status check contexts
Parameters
- payload Required_status_checks_contexts_body_1 -
delete repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks/contexts
function delete repos/[string owner]/[string repo]/branches/[string branch]/protection/required_status_checks/contexts(Required_status_checks_contexts_body_2 payload) returns string[]|error
Remove status check contexts
Parameters
- payload Required_status_checks_contexts_body_2 -
get repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions
function get repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions() returns BranchRestrictionPolicy|error
Get access restrictions
Return Type
- BranchRestrictionPolicy|error - Response
delete repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions
function delete repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions() returns error?
Delete access restrictions
Return Type
- error? - Response
get repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/apps
function get repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/apps() returns Integration[]|error
Get apps with access to the protected branch
Return Type
- Integration[]|error - Response
put repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/apps
function put repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/apps(Restrictions_apps_body payload) returns Integration[]|error
Set app access restrictions
Parameters
- payload Restrictions_apps_body -
Return Type
- Integration[]|error - Response
post repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/apps
function post repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/apps(Restrictions_apps_body_1 payload) returns Integration[]|error
Add app access restrictions
Parameters
- payload Restrictions_apps_body_1 -
Return Type
- Integration[]|error - Response
delete repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/apps
function delete repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/apps(Restrictions_apps_body_2 payload) returns Integration[]|error
Remove app access restrictions
Parameters
- payload Restrictions_apps_body_2 -
Return Type
- Integration[]|error - Response
get repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/teams
function get repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/teams() returns Team[]|error
Get teams with access to the protected branch
put repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/teams
function put repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/teams(Restrictions_teams_body payload) returns Team[]|error
Set team access restrictions
Parameters
- payload Restrictions_teams_body -
post repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/teams
function post repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/teams(Restrictions_teams_body_1 payload) returns Team[]|error
Add team access restrictions
Parameters
- payload Restrictions_teams_body_1 -
delete repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/teams
function delete repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/teams(Restrictions_teams_body_2 payload) returns Team[]|error
Remove team access restrictions
Parameters
- payload Restrictions_teams_body_2 -
get repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/users
function get repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/users() returns SimpleUser[]|error
Get users with access to the protected branch
Return Type
- SimpleUser[]|error - Response
put repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/users
function put repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/users(Restrictions_users_body payload) returns SimpleUser[]|error
Set user access restrictions
Parameters
- payload Restrictions_users_body -
Return Type
- SimpleUser[]|error - Response
post repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/users
function post repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/users(Restrictions_users_body_1 payload) returns SimpleUser[]|error
Add user access restrictions
Parameters
- payload Restrictions_users_body_1 -
Return Type
- SimpleUser[]|error - Response
delete repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/users
function delete repos/[string owner]/[string repo]/branches/[string branch]/protection/restrictions/users(Restrictions_users_body_2 payload) returns SimpleUser[]|error
Remove user access restrictions
Parameters
- payload Restrictions_users_body_2 -
Return Type
- SimpleUser[]|error - Response
post repos/[string owner]/[string repo]/branches/[string branch]/rename
function post repos/[string owner]/[string repo]/branches/[string branch]/rename(Branch_rename_body payload) returns BranchWithProtection|error
Rename a branch
Parameters
- payload Branch_rename_body -
Return Type
- BranchWithProtection|error - Response
post repos/[string owner]/[string repo]/check-runs
function post repos/[string owner]/[string repo]/check\-runs(Repo_checkruns_body payload) returns CheckRun|error
Create a check run
Parameters
- payload Repo_checkruns_body -
get repos/[string owner]/[string repo]/check-runs/[int check_run_id]
function get repos/[string owner]/[string repo]/check\-runs/[int check_run_id]() returns CheckRun|error
Get a check run
patch repos/[string owner]/[string repo]/check-runs/[int check_run_id]
function patch repos/[string owner]/[string repo]/check\-runs/[int check_run_id](Checkruns_check_run_id_body payload) returns CheckRun|error
Update a check run
Parameters
- payload Checkruns_check_run_id_body -
get repos/[string owner]/[string repo]/check-runs/[int check_run_id]/annotations
function get repos/[string owner]/[string repo]/check\-runs/[int check_run_id]/annotations(int per_page, int page) returns CheckAnnotation[]|error
List check run annotations
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CheckAnnotation[]|error - Response
post repos/[string owner]/[string repo]/check-runs/[int check_run_id]/rerequest
function post repos/[string owner]/[string repo]/check\-runs/[int check_run_id]/rerequest() returns EmptyObject|error
Rerequest a check run
Return Type
- EmptyObject|error - Response
post repos/[string owner]/[string repo]/check-suites
function post repos/[string owner]/[string repo]/check\-suites(Repo_checksuites_body payload) returns CheckSuite|error
Create a check suite
Parameters
- payload Repo_checksuites_body -
Return Type
- CheckSuite|error - Response when the suite already exists
patch repos/[string owner]/[string repo]/check-suites/preferences
function patch repos/[string owner]/[string repo]/check\-suites/preferences(Checksuites_preferences_body payload) returns CheckSuitePreference|error
Update repository preferences for check suites
Parameters
- payload Checksuites_preferences_body -
Return Type
- CheckSuitePreference|error - Response
get repos/[string owner]/[string repo]/check-suites/[int check_suite_id]
function get repos/[string owner]/[string repo]/check\-suites/[int check_suite_id]() returns CheckSuite|error
Get a check suite
Return Type
- CheckSuite|error - Response
get repos/[string owner]/[string repo]/check-suites/[int check_suite_id]/check-runs
function get repos/[string owner]/[string repo]/check\-suites/[int check_suite_id]/check\-runs(string? check_name, "queued"|"in_progress"|"completed"? status, "latest"|"all" filter, int per_page, int page) returns CheckRunResponse|error
List check runs in a check suite
Parameters
- check_name string? (default ()) - Returns check runs with the specified
name
.
- status "queued"|"in_progress"|"completed"? (default ()) - Returns check runs with the specified
status
.
- filter "latest"|"all" (default "latest") - Filters check runs by their
completed_at
timestamp.latest
returns the most recent check runs.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CheckRunResponse|error - Response
post repos/[string owner]/[string repo]/check-suites/[int check_suite_id]/rerequest
function post repos/[string owner]/[string repo]/check\-suites/[int check_suite_id]/rerequest() returns EmptyObject|error
Rerequest a check suite
Return Type
- EmptyObject|error - Response
get repos/[string owner]/[string repo]/code-scanning/alerts
function get repos/[string owner]/[string repo]/code\-scanning/alerts(CodeScanningAnalysisToolName? tool_name, CodeScanningAnalysisToolGuid? tool_guid, int page, int per_page, CodeScanningRef? ref, "asc"|"desc" direction, "created"|"updated" sort, CodeScanningAlertStateQuery? state, CodeScanningAlertSeverity? severity) returns CodeScanningAlertItems[]|error
List code scanning alerts for a repository
Parameters
- tool_name CodeScanningAnalysisToolName? (default ()) - 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
ortool_guid
, but not both.
- tool_guid CodeScanningAnalysisToolGuid? (default ()) - 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
ortool_name
, but not both.
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
- ref CodeScanningRef? (default ()) - The Git reference for the results you want to list. The
ref
for a branch can be formatted either asrefs/heads/<branch name>
or simply<branch name>
. To reference a pull request userefs/pull/<number>/merge
.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- sort "created"|"updated" (default "created") - The property by which to sort the results.
- state CodeScanningAlertStateQuery? (default ()) - If specified, only code scanning alerts with this state will be returned.
- severity CodeScanningAlertSeverity? (default ()) - If specified, only code scanning alerts with this severity will be returned.
Return Type
- CodeScanningAlertItems[]|error - Response
get repos/[string owner]/[string repo]/code-scanning/alerts/[AlertNumber alert_number]
function get repos/[string owner]/[string repo]/code\-scanning/alerts/[AlertNumber alert_number]() returns CodeScanningAlert|error
Get a code scanning alert
Return Type
- CodeScanningAlert|error - Response
patch repos/[string owner]/[string repo]/code-scanning/alerts/[AlertNumber alert_number]
function patch repos/[string owner]/[string repo]/code\-scanning/alerts/[AlertNumber alert_number](Alerts_alert_number_body payload) returns CodeScanningAlert|error
Update a code scanning alert
Parameters
- payload Alerts_alert_number_body -
Return Type
- CodeScanningAlert|error - Response
get repos/[string owner]/[string repo]/code-scanning/alerts/[AlertNumber alert_number]/instances
function get repos/[string owner]/[string repo]/code\-scanning/alerts/[AlertNumber alert_number]/instances(int page, int per_page, CodeScanningRef? ref) returns CodeScanningAlertInstance[]|error
List instances of a code scanning alert
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
- ref CodeScanningRef? (default ()) - The Git reference for the results you want to list. The
ref
for a branch can be formatted either asrefs/heads/<branch name>
or simply<branch name>
. To reference a pull request userefs/pull/<number>/merge
.
Return Type
- CodeScanningAlertInstance[]|error - Response
get repos/[string owner]/[string repo]/code-scanning/analyses
function get repos/[string owner]/[string repo]/code\-scanning/analyses(CodeScanningAnalysisToolName? tool_name, CodeScanningAnalysisToolGuid? tool_guid, int page, int per_page, CodeScanningRef? ref, CodeScanningAnalysisSarifId? sarif_id, "asc"|"desc" direction, "created" sort) returns CodeScanningAnalysis[]|error
List code scanning analyses for a repository
Parameters
- tool_name CodeScanningAnalysisToolName? (default ()) - 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
ortool_guid
, but not both.
- tool_guid CodeScanningAnalysisToolGuid? (default ()) - 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
ortool_name
, but not both.
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
- ref CodeScanningRef? (default ()) - The Git reference for the analyses you want to list. The
ref
for a branch can be formatted either asrefs/heads/<branch name>
or simply<branch name>
. To reference a pull request userefs/pull/<number>/merge
.
- sarif_id CodeScanningAnalysisSarifId? (default ()) - Filter analyses belonging to the same SARIF upload.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- sort "created" (default "created") - The property by which to sort the results.
Return Type
- CodeScanningAnalysis[]|error - Response
get repos/[string owner]/[string repo]/code-scanning/analyses/[int analysis_id]
function get repos/[string owner]/[string repo]/code\-scanning/analyses/[int analysis_id]() returns CodeScanningAnalysis|error
Get a code scanning analysis for a repository
Return Type
- CodeScanningAnalysis|error - Response
delete repos/[string owner]/[string repo]/code-scanning/analyses/[int analysis_id]
function delete repos/[string owner]/[string repo]/code\-scanning/analyses/[int analysis_id](string? confirm_delete) returns CodeScanningAnalysisDeletion|error
Delete a code scanning analysis from a repository
Parameters
- confirm_delete string? (default ()) - 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.
Return Type
- CodeScanningAnalysisDeletion|error - Response
get repos/[string owner]/[string repo]/code-scanning/codeql/databases
function get repos/[string owner]/[string repo]/code\-scanning/codeql/databases() returns CodeScanningCodeqlDatabase[]|error
List CodeQL databases for a repository
Return Type
- CodeScanningCodeqlDatabase[]|error - Response
get repos/[string owner]/[string repo]/code-scanning/codeql/databases/[string language]
function get repos/[string owner]/[string repo]/code\-scanning/codeql/databases/[string language]() returns CodeScanningCodeqlDatabase|error
Get a CodeQL database for a repository
Return Type
- CodeScanningCodeqlDatabase|error - Response
get repos/[string owner]/[string repo]/code-scanning/default-setup
function get repos/[string owner]/[string repo]/code\-scanning/default\-setup() returns CodeScanningDefaultSetup|error
Get a code scanning default setup configuration
Return Type
- CodeScanningDefaultSetup|error - Response
patch repos/[string owner]/[string repo]/code-scanning/default-setup
function patch repos/[string owner]/[string repo]/code\-scanning/default\-setup(CodeScanningDefaultSetupUpdate payload) returns EmptyObject|CodeScanningDefaultSetupUpdateResponse|error
Update a code scanning default setup configuration
Parameters
- payload CodeScanningDefaultSetupUpdate -
Return Type
post repos/[string owner]/[string repo]/code-scanning/sarifs
function post repos/[string owner]/[string repo]/code\-scanning/sarifs(Codescanning_sarifs_body payload) returns CodeScanningSarifsReceipt|error
Upload an analysis as SARIF data
Parameters
- payload Codescanning_sarifs_body -
Return Type
- CodeScanningSarifsReceipt|error - Response
get repos/[string owner]/[string repo]/code-scanning/sarifs/[string sarif_id]
function get repos/[string owner]/[string repo]/code\-scanning/sarifs/[string sarif_id]() returns CodeScanningSarifsStatus|error
Get information about a SARIF upload
Return Type
- CodeScanningSarifsStatus|error - Response
get repos/[string owner]/[string repo]/codeowners/errors
function get repos/[string owner]/[string repo]/codeowners/errors(string? ref) returns CodeownersErrors|error
List CODEOWNERS errors
Parameters
- ref string? (default ()) - 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
)
Return Type
- CodeownersErrors|error - Response
get repos/[string owner]/[string repo]/codespaces
function get repos/[string owner]/[string repo]/codespaces(int per_page, int page) returns CodespaceResponse|error
List codespaces in a repository for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CodespaceResponse|error - Response
post repos/[string owner]/[string repo]/codespaces
function post repos/[string owner]/[string repo]/codespaces(Repo_codespaces_body payload) returns Codespace|error
Create a codespace in a repository
Parameters
- payload Repo_codespaces_body -
get repos/[string owner]/[string repo]/codespaces/devcontainers
function get repos/[string owner]/[string repo]/codespaces/devcontainers(int per_page, int page) returns DevcontainersResponse|error
List devcontainer configurations in a repository for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- DevcontainersResponse|error - Response
get repos/[string owner]/[string repo]/codespaces/machines
function get repos/[string owner]/[string repo]/codespaces/machines(string? location, string? client_ip, string? ref) returns CodespaceMachineResponse|error
List available machine types for a repository
Parameters
- location string? (default ()) - The location to check for available machines. Assigned by IP if not provided.
- client_ip string? (default ()) - IP for location auto-detection when proxying a request
- ref string? (default ()) - The branch or commit to check for prebuild availability and devcontainer restrictions.
Return Type
- CodespaceMachineResponse|error - Response
get repos/[string owner]/[string repo]/codespaces/'new
function get repos/[string owner]/[string repo]/codespaces/'new(string? ref, string? client_ip) returns CodespaceDefaultResponse|error
Get default attributes for a codespace
Parameters
- ref string? (default ()) - The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.
- client_ip string? (default ()) - An alternative IP for default location auto-detection, such as when proxying a request.
Return Type
- CodespaceDefaultResponse|error - Response when a user is able to create codespaces from the repository.
get repos/[string owner]/[string repo]/codespaces/permissions_check
function get repos/[string owner]/[string repo]/codespaces/permissions_check(string ref, string devcontainer_path) returns CodespacesPermissionsCheckForDevcontainer|error
Check if permissions defined by a devcontainer have been accepted by the authenticated user
Parameters
- ref string - The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of
ref
will typically be a branch name (heads/BRANCH_NAME
). For more information, see "Git References" in the Git documentation.
- devcontainer_path string - Path to the devcontainer.json configuration to use for the permission check.
Return Type
- CodespacesPermissionsCheckForDevcontainer|error - Response when the permission check is successful
get repos/[string owner]/[string repo]/codespaces/secrets
function get repos/[string owner]/[string repo]/codespaces/secrets(int per_page, int page) returns RepoCodespacesSecretResponse|error
List repository secrets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RepoCodespacesSecretResponse|error - Response
get repos/[string owner]/[string repo]/codespaces/secrets/public-key
function get repos/[string owner]/[string repo]/codespaces/secrets/public\-key() returns CodespacesPublicKey|error
Get a repository public key
Return Type
- CodespacesPublicKey|error - Response
get repos/[string owner]/[string repo]/codespaces/secrets/[string secret_name]
function get repos/[string owner]/[string repo]/codespaces/secrets/[string secret_name]() returns RepoCodespacesSecret|error
Get a repository secret
Return Type
- RepoCodespacesSecret|error - Response
put repos/[string owner]/[string repo]/codespaces/secrets/[string secret_name]
function put repos/[string owner]/[string repo]/codespaces/secrets/[string secret_name](Secrets_secret_name_body_4 payload) returns EmptyObject|error?
Create or update a repository secret
Parameters
- payload Secrets_secret_name_body_4 -
Return Type
- EmptyObject|error? - Response when creating a secret
delete repos/[string owner]/[string repo]/codespaces/secrets/[string secret_name]
function delete repos/[string owner]/[string repo]/codespaces/secrets/[string secret_name]() returns error?
Delete a repository secret
Return Type
- error? - Response
get repos/[string owner]/[string repo]/collaborators
function get repos/[string owner]/[string repo]/collaborators("outside"|"direct"|"all" affiliation, "pull"|"triage"|"push"|"maintain"|"admin"? permission, int per_page, int page) returns Collaborator[]|error
List repository collaborators
Parameters
- affiliation "outside"|"direct"|"all" (default "all") - 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.
- permission "pull"|"triage"|"push"|"maintain"|"admin"? (default ()) - Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- Collaborator[]|error - Response
get repos/[string owner]/[string repo]/collaborators/[string username]
function get repos/[string owner]/[string repo]/collaborators/[string username]() returns Response|error
Check if a user is a repository collaborator
put repos/[string owner]/[string repo]/collaborators/[string username]
function put repos/[string owner]/[string repo]/collaborators/[string username](Collaborators_username_body_1 payload) returns RepositoryInvitation|error
Add a repository collaborator
Parameters
- payload Collaborators_username_body_1 -
Return Type
- RepositoryInvitation|error - Response when a new invitation is created
delete repos/[string owner]/[string repo]/collaborators/[string username]
function delete repos/[string owner]/[string repo]/collaborators/[string username]() returns Response|error
Remove a repository collaborator
get repos/[string owner]/[string repo]/collaborators/[string username]/permission
function get repos/[string owner]/[string repo]/collaborators/[string username]/permission() returns RepositoryCollaboratorPermission|error
Get repository permissions for a user
Return Type
- RepositoryCollaboratorPermission|error - if user has admin permissions
get repos/[string owner]/[string repo]/comments
function get repos/[string owner]/[string repo]/comments(int per_page, int page) returns CommitComment[]|error
List commit comments for a repository
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CommitComment[]|error - Response
get repos/[string owner]/[string repo]/comments/[int comment_id]
function get repos/[string owner]/[string repo]/comments/[int comment_id]() returns CommitComment|error
Get a commit comment
Return Type
- CommitComment|error - Response
delete repos/[string owner]/[string repo]/comments/[int comment_id]
function delete repos/[string owner]/[string repo]/comments/[int comment_id]() returns Response|error
Delete a commit comment
patch repos/[string owner]/[string repo]/comments/[int comment_id]
function patch repos/[string owner]/[string repo]/comments/[int comment_id](Comments_comment_id_body_1 payload) returns CommitComment|error
Update a commit comment
Parameters
- payload Comments_comment_id_body_1 -
Return Type
- CommitComment|error - Response
get repos/[string owner]/[string repo]/comments/[int comment_id]/reactions
function get repos/[string owner]/[string repo]/comments/[int comment_id]/reactions("+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? content, int per_page, int page) returns Reaction[]|error
List reactions for a commit comment
Parameters
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? (default ()) - Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/comments/[int comment_id]/reactions
function post repos/[string owner]/[string repo]/comments/[int comment_id]/reactions(Comment_id_reactions_body payload) returns Reaction|error
Create reaction for a commit comment
Parameters
- payload Comment_id_reactions_body -
delete repos/[string owner]/[string repo]/comments/[int comment_id]/reactions/[int reaction_id]
function delete repos/[string owner]/[string repo]/comments/[int comment_id]/reactions/[int reaction_id]() returns error?
Delete a commit comment reaction
Return Type
- error? - Response
get repos/[string owner]/[string repo]/commits
function get repos/[string owner]/[string repo]/commits(string? sha, string? path, string? author, string? committer, string? since, string? until, int per_page, int page) returns Commit[]|error
List commits
Parameters
- sha string? (default ()) - SHA or branch to start listing commits from. Default: the repository’s default branch (usually
main
).
- path string? (default ()) - Only commits containing this file path will be returned.
- author string? (default ()) - GitHub username or email address to use to filter by commit author.
- committer string? (default ()) - GitHub username or email address to use to filter by commit committer.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get repos/[string owner]/[string repo]/commits/[string commit_sha]/branches-where-head
function get repos/[string owner]/[string repo]/commits/[string commit_sha]/branches\-where\-head() returns BranchShort[]|error
List branches for HEAD commit
Return Type
- BranchShort[]|error - Response
get repos/[string owner]/[string repo]/commits/[string commit_sha]/comments
function get repos/[string owner]/[string repo]/commits/[string commit_sha]/comments(int per_page, int page) returns CommitComment[]|error
List commit comments
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CommitComment[]|error - Response
post repos/[string owner]/[string repo]/commits/[string commit_sha]/comments
function post repos/[string owner]/[string repo]/commits/[string commit_sha]/comments(Commit_sha_comments_body payload) returns CommitComment|error
Create a commit comment
Parameters
- payload Commit_sha_comments_body -
Return Type
- CommitComment|error - Response
get repos/[string owner]/[string repo]/commits/[string commit_sha]/pulls
function get repos/[string owner]/[string repo]/commits/[string commit_sha]/pulls(int per_page, int page) returns PullRequestSimple[]|error
List pull requests associated with a commit
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- PullRequestSimple[]|error - Response
get repos/[string owner]/[string repo]/commits/[string ref]
function get repos/[string owner]/[string repo]/commits/[string ref](int page, int per_page) returns Commit|error
Get a commit
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
get repos/[string owner]/[string repo]/commits/[string ref]/check-runs
function get repos/[string owner]/[string repo]/commits/[string ref]/check\-runs(string? check_name, "queued"|"in_progress"|"completed"? status, "latest"|"all" filter, int per_page, int page, int? app_id) returns CheckRunResponse|error
List check runs for a Git reference
Parameters
- check_name string? (default ()) - Returns check runs with the specified
name
.
- status "queued"|"in_progress"|"completed"? (default ()) - Returns check runs with the specified
status
.
- filter "latest"|"all" (default "latest") - Filters check runs by their
completed_at
timestamp.latest
returns the most recent check runs.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- app_id int? (default ()) -
Return Type
- CheckRunResponse|error - Response
get repos/[string owner]/[string repo]/commits/[string ref]/check-suites
function get repos/[string owner]/[string repo]/commits/[string ref]/check\-suites(int? app_id, string? check_name, int per_page, int page) returns CheckSuiteResponse|error
List check suites for a Git reference
Parameters
- app_id int? (default ()) - Filters check suites by GitHub App
id
.
- check_name string? (default ()) - Returns check runs with the specified
name
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CheckSuiteResponse|error - Response
get repos/[string owner]/[string repo]/commits/[string ref]/status
function get repos/[string owner]/[string repo]/commits/[string ref]/status(int per_page, int page) returns CombinedCommitStatus|error
Get the combined status for a specific reference
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CombinedCommitStatus|error - Response
get repos/[string owner]/[string repo]/commits/[string ref]/statuses
function get repos/[string owner]/[string repo]/commits/[string ref]/statuses(int per_page, int page) returns Status[]|error
List commit statuses for a reference
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get repos/[string owner]/[string repo]/community/profile
function get repos/[string owner]/[string repo]/community/profile() returns CommunityProfile|error
Get community profile metrics
Return Type
- CommunityProfile|error - Response
get repos/[string owner]/[string repo]/compare/[string basehead]
function get repos/[string owner]/[string repo]/compare/[string basehead](int page, int per_page) returns CommitComparison|error
Compare two commits
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- CommitComparison|error - Response
get repos/[string owner]/[string repo]/contents/[string path]
function get repos/[string owner]/[string repo]/contents/[string path](string? ref) returns ContentTree[]|error?
Get repository content
Parameters
- ref string? (default ()) - The name of the commit/branch/tag. Default: the repository’s default branch.
Return Type
- ContentTree[]|error? - Response
put repos/[string owner]/[string repo]/contents/[string path]
function put repos/[string owner]/[string repo]/contents/[string path](Contents_path_body payload) returns FileCommit|error
Create or update file contents
Parameters
- payload Contents_path_body -
Return Type
- FileCommit|error - Response
delete repos/[string owner]/[string repo]/contents/[string path]
function delete repos/[string owner]/[string repo]/contents/[string path](Contents_path_body_1 payload) returns FileCommit|error
Delete a file
Parameters
- payload Contents_path_body_1 -
Return Type
- FileCommit|error - Response
get repos/[string owner]/[string repo]/contributors
function get repos/[string owner]/[string repo]/contributors(string? anon, int per_page, int page) returns Contributor[]|error
List repository contributors
Parameters
- anon string? (default ()) - Set to
1
ortrue
to include anonymous contributors in results.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- Contributor[]|error - If repository contains content
get repos/[string owner]/[string repo]/dependabot/alerts
function get repos/[string owner]/[string repo]/dependabot/alerts(string? state, string? severity, string? ecosystem, string? package, string? manifest, "development"|"runtime"? scope, "created"|"updated" sort, "asc"|"desc" direction, int page, int per_page, string? before, string? after, int first, int? last) returns DependabotAlert[]|error
List Dependabot alerts for a repository
Parameters
- state string? (default ()) - A comma-separated list of states. If specified, only alerts with these states will be returned.
Can be:
auto_dismissed
,dismissed
,fixed
,open
- severity string? (default ()) - A comma-separated list of severities. If specified, only alerts with these severities will be returned.
Can be:
low
,medium
,high
,critical
- ecosystem string? (default ()) - A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
Can be:
composer
,go
,maven
,npm
,nuget
,pip
,pub
,rubygems
,rust
- package string? (default ()) - A comma-separated list of package names. If specified, only alerts for these packages will be returned.
- manifest string? (default ()) - A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.
- scope "development"|"runtime"? (default ()) - The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.
- sort "created"|"updated" (default "created") - The property by which to sort the results.
created
means when the alert was created.updated
means when the alert's state last changed.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- page int (default 1) - Deprecated. Page number of the results to fetch. Use cursor-based pagination with
before
orafter
instead.
- per_page int (default 30) - The number of results per page (max 100).
- before string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
- after string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
- first int (default 30) - Deprecated. The number of results per page (max 100), starting from the first matching result.
This parameter must not be used in combination with
last
. Instead, useper_page
in combination withafter
to fetch the first page of results.
- last int? (default ()) - Deprecated. The number of results per page (max 100), starting from the last matching result.
This parameter must not be used in combination with
first
. Instead, useper_page
in combination withbefore
to fetch the last page of results.Deprecated parameters
Return Type
- DependabotAlert[]|error - Response
get repos/[string owner]/[string repo]/dependabot/alerts/[AlertNumber alert_number]
function get repos/[string owner]/[string repo]/dependabot/alerts/[AlertNumber alert_number]() returns DependabotAlert|error
Get a Dependabot alert
Return Type
- DependabotAlert|error - Response
patch repos/[string owner]/[string repo]/dependabot/alerts/[AlertNumber alert_number]
function patch repos/[string owner]/[string repo]/dependabot/alerts/[AlertNumber alert_number](Alerts_alert_number_body_1 payload) returns DependabotAlert|error
Update a Dependabot alert
Parameters
- payload Alerts_alert_number_body_1 -
Return Type
- DependabotAlert|error - Response
get repos/[string owner]/[string repo]/dependabot/secrets
function get repos/[string owner]/[string repo]/dependabot/secrets(int per_page, int page) returns DependabotSecretResponse|error
List repository secrets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- DependabotSecretResponse|error - Response
get repos/[string owner]/[string repo]/dependabot/secrets/public-key
function get repos/[string owner]/[string repo]/dependabot/secrets/public\-key() returns DependabotPublicKey|error
Get a repository public key
Return Type
- DependabotPublicKey|error - Response
get repos/[string owner]/[string repo]/dependabot/secrets/[string secret_name]
function get repos/[string owner]/[string repo]/dependabot/secrets/[string secret_name]() returns DependabotSecret|error
Get a repository secret
Return Type
- DependabotSecret|error - Response
put repos/[string owner]/[string repo]/dependabot/secrets/[string secret_name]
function put repos/[string owner]/[string repo]/dependabot/secrets/[string secret_name](Secrets_secret_name_body_5 payload) returns EmptyObject|error?
Create or update a repository secret
Parameters
- payload Secrets_secret_name_body_5 -
Return Type
- EmptyObject|error? - Response when creating a secret
delete repos/[string owner]/[string repo]/dependabot/secrets/[string secret_name]
function delete repos/[string owner]/[string repo]/dependabot/secrets/[string secret_name]() returns error?
Delete a repository secret
Return Type
- error? - Response
get repos/[string owner]/[string repo]/dependency-graph/compare/[string basehead]
function get repos/[string owner]/[string repo]/dependency\-graph/compare/[string basehead](string? name) returns DependencyGraphDiff|error
Get a diff of the dependencies between commits
Parameters
- name string? (default ()) - The full path, relative to the repository root, of the dependency manifest file.
Return Type
- DependencyGraphDiff|error - Response
get repos/[string owner]/[string repo]/dependency-graph/sbom
function get repos/[string owner]/[string repo]/dependency\-graph/sbom() returns DependencyGraphSpdxSbom|error
Export a software bill of materials (SBOM) for a repository.
Return Type
- DependencyGraphSpdxSbom|error - Response
post repos/[string owner]/[string repo]/dependency-graph/snapshots
function post repos/[string owner]/[string repo]/dependency\-graph/snapshots(Snapshot payload) returns SnapshotResponse|error
Create a snapshot of dependencies for a repository
Parameters
- payload Snapshot -
Return Type
- SnapshotResponse|error - Response
get repos/[string owner]/[string repo]/deployments
function get repos/[string owner]/[string repo]/deployments(string sha, string ref, string task, string environment, int per_page, int page) returns Deployment[]|error
List deployments
Parameters
- sha string (default "none") - The SHA recorded at creation time.
- ref string (default "none") - The name of the ref. This can be a branch, tag, or SHA.
- task string (default "none") - The name of the task for the deployment (e.g.,
deploy
ordeploy:migrations
).
- environment string (default "none") - The name of the environment that was deployed to (e.g.,
staging
orproduction
).
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- Deployment[]|error - Response
post repos/[string owner]/[string repo]/deployments
function post repos/[string owner]/[string repo]/deployments(Repo_deployments_body payload) returns MergedBranchResponse|Deployment|error
Create a deployment
Parameters
- payload Repo_deployments_body -
Return Type
- MergedBranchResponse|Deployment|error - Response
get repos/[string owner]/[string repo]/deployments/[int deployment_id]
function get repos/[string owner]/[string repo]/deployments/[int deployment_id]() returns Deployment|error
Get a deployment
Return Type
- Deployment|error - Response
delete repos/[string owner]/[string repo]/deployments/[int deployment_id]
function delete repos/[string owner]/[string repo]/deployments/[int deployment_id]() returns Response|error
Delete a deployment
get repos/[string owner]/[string repo]/deployments/[int deployment_id]/statuses
function get repos/[string owner]/[string repo]/deployments/[int deployment_id]/statuses(int per_page, int page) returns DeploymentStatus[]|error
List deployment statuses
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- DeploymentStatus[]|error - Response
post repos/[string owner]/[string repo]/deployments/[int deployment_id]/statuses
function post repos/[string owner]/[string repo]/deployments/[int deployment_id]/statuses(Deployment_id_statuses_body payload) returns DeploymentStatus|error
Create a deployment status
Parameters
- payload Deployment_id_statuses_body -
Return Type
- DeploymentStatus|error - Response
get repos/[string owner]/[string repo]/deployments/[int deployment_id]/statuses/[int status_id]
function get repos/[string owner]/[string repo]/deployments/[int deployment_id]/statuses/[int status_id]() returns DeploymentStatus|error
Get a deployment status
Return Type
- DeploymentStatus|error - Response
post repos/[string owner]/[string repo]/dispatches
function post repos/[string owner]/[string repo]/dispatches(Repo_dispatches_body payload) returns Response|error
Create a repository dispatch event
Parameters
- payload Repo_dispatches_body -
get repos/[string owner]/[string repo]/environments
function get repos/[string owner]/[string repo]/environments(int per_page, int page) returns EnvironmentResponse|error
List environments
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- EnvironmentResponse|error - Response
get repos/[string owner]/[string repo]/environments/[string environment_name]
function get repos/[string owner]/[string repo]/environments/[string environment_name]() returns Environment|error
Get an environment
Return Type
- Environment|error - Response
put repos/[string owner]/[string repo]/environments/[string environment_name]
function put repos/[string owner]/[string repo]/environments/[string environment_name](Environments_environment_name_body payload) returns Environment|error
Create or update an environment
Parameters
- payload Environments_environment_name_body -
Return Type
- Environment|error - Response
delete repos/[string owner]/[string repo]/environments/[string environment_name]
function delete repos/[string owner]/[string repo]/environments/[string environment_name]() returns error?
Delete an environment
Return Type
- error? - Default response
get repos/[string owner]/[string repo]/environments/[string environment_name]/deployment-branch-policies
function get repos/[string owner]/[string repo]/environments/[string environment_name]/deployment\-branch\-policies(int per_page, int page) returns DeploymentBranchPolicyResponse|error
List deployment branch policies
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- DeploymentBranchPolicyResponse|error - Response
post repos/[string owner]/[string repo]/environments/[string environment_name]/deployment-branch-policies
function post repos/[string owner]/[string repo]/environments/[string environment_name]/deployment\-branch\-policies(DeploymentBranchPolicyNamePatternWithType payload) returns DeploymentBranchPolicy|error?
Create a deployment branch policy
Parameters
Return Type
- DeploymentBranchPolicy|error? - Response
get repos/[string owner]/[string repo]/environments/[string environment_name]/deployment-branch-policies/[int branch_policy_id]
function get repos/[string owner]/[string repo]/environments/[string environment_name]/deployment\-branch\-policies/[int branch_policy_id]() returns DeploymentBranchPolicy|error
Get a deployment branch policy
Return Type
- DeploymentBranchPolicy|error - Response
put repos/[string owner]/[string repo]/environments/[string environment_name]/deployment-branch-policies/[int branch_policy_id]
function put repos/[string owner]/[string repo]/environments/[string environment_name]/deployment\-branch\-policies/[int branch_policy_id](DeploymentBranchPolicyNamePattern payload) returns DeploymentBranchPolicy|error
Update a deployment branch policy
Parameters
- payload DeploymentBranchPolicyNamePattern -
Return Type
- DeploymentBranchPolicy|error - Response
delete repos/[string owner]/[string repo]/environments/[string environment_name]/deployment-branch-policies/[int branch_policy_id]
function delete repos/[string owner]/[string repo]/environments/[string environment_name]/deployment\-branch\-policies/[int branch_policy_id]() returns error?
Delete a deployment branch policy
Return Type
- error? - Response
get repos/[string owner]/[string repo]/environments/[string environment_name]/deployment_protection_rules
function get repos/[string owner]/[string repo]/environments/[string environment_name]/deployment_protection_rules() returns DeploymentProtectionRuleResponse|error
Get all deployment protection rules for an environment
Return Type
- DeploymentProtectionRuleResponse|error - List of deployment protection rules
post repos/[string owner]/[string repo]/environments/[string environment_name]/deployment_protection_rules
function post repos/[string owner]/[string repo]/environments/[string environment_name]/deployment_protection_rules(Environment_name_deployment_protection_rules_body payload) returns DeploymentProtectionRule|error
Create a custom deployment protection rule on an environment
Parameters
Return Type
- DeploymentProtectionRule|error - The enabled custom deployment protection rule
get repos/[string owner]/[string repo]/environments/[string environment_name]/deployment_protection_rules/apps
function get repos/[string owner]/[string repo]/environments/[string environment_name]/deployment_protection_rules/apps(int page, int per_page) returns CustomDeploymentRuleAppResponse|error
List custom deployment rule integrations available for an environment
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- CustomDeploymentRuleAppResponse|error - A list of custom deployment rule integrations available for this environment.
get repos/[string owner]/[string repo]/environments/[string environment_name]/deployment_protection_rules/[int protection_rule_id]
function get repos/[string owner]/[string repo]/environments/[string environment_name]/deployment_protection_rules/[int protection_rule_id]() returns DeploymentProtectionRule|error
Get a custom deployment protection rule
Return Type
- DeploymentProtectionRule|error - Response
delete repos/[string owner]/[string repo]/environments/[string environment_name]/deployment_protection_rules/[int protection_rule_id]
function delete repos/[string owner]/[string repo]/environments/[string environment_name]/deployment_protection_rules/[int protection_rule_id]() returns error?
Disable a custom protection rule for an environment
Return Type
- error? - Response
get repos/[string owner]/[string repo]/events
function get repos/[string owner]/[string repo]/events(int per_page, int page) returns Event[]|error
List repository events
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get repos/[string owner]/[string repo]/forks
function get repos/[string owner]/[string repo]/forks("newest"|"oldest"|"stargazers"|"watchers" sort, int per_page, int page) returns MinimalRepository[]|error
List forks
Parameters
- sort "newest"|"oldest"|"stargazers"|"watchers" (default "newest") - The sort order.
stargazers
will sort by star count.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Response
post repos/[string owner]/[string repo]/forks
function post repos/[string owner]/[string repo]/forks(Repo_forks_body payload) returns FullRepository|error
Create a fork
Parameters
- payload Repo_forks_body -
Return Type
- FullRepository|error - Response
post repos/[string owner]/[string repo]/git/blobs
function post repos/[string owner]/[string repo]/git/blobs(Git_blobs_body payload) returns ShortBlob|error
Create a blob
Parameters
- payload Git_blobs_body -
get repos/[string owner]/[string repo]/git/blobs/[string file_sha]
Get a blob
post repos/[string owner]/[string repo]/git/commits
function post repos/[string owner]/[string repo]/git/commits(Git_commits_body payload) returns GitCommit|error
Create a commit
Parameters
- payload Git_commits_body -
get repos/[string owner]/[string repo]/git/commits/[string commit_sha]
function get repos/[string owner]/[string repo]/git/commits/[string commit_sha]() returns GitCommit|error
Get a commit object
get repos/[string owner]/[string repo]/git/matching-refs/[string ref]
function get repos/[string owner]/[string repo]/git/matching\-refs/[string ref]() returns GitRef[]|error
List matching references
get repos/[string owner]/[string repo]/git/ref/[string ref]
Get a reference
post repos/[string owner]/[string repo]/git/refs
function post repos/[string owner]/[string repo]/git/refs(Git_refs_body payload) returns GitRef|error
Create a reference
Parameters
- payload Git_refs_body -
delete repos/[string owner]/[string repo]/git/refs/[string ref]
Delete a reference
patch repos/[string owner]/[string repo]/git/refs/[string ref]
function patch repos/[string owner]/[string repo]/git/refs/[string ref](Refs_ref_body payload) returns GitRef|error
Update a reference
Parameters
- payload Refs_ref_body -
post repos/[string owner]/[string repo]/git/tags
function post repos/[string owner]/[string repo]/git/tags(Git_tags_body payload) returns GitTag|error
Create a tag object
Parameters
- payload Git_tags_body -
get repos/[string owner]/[string repo]/git/tags/[string tag_sha]
Get a tag
post repos/[string owner]/[string repo]/git/trees
function post repos/[string owner]/[string repo]/git/trees(Git_trees_body payload) returns GitTree|error
Create a tree
Parameters
- payload Git_trees_body -
get repos/[string owner]/[string repo]/git/trees/[string tree_sha]
function get repos/[string owner]/[string repo]/git/trees/[string tree_sha](string? recursive) returns GitTree|error
Get a tree
Parameters
- recursive string? (default ()) - Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in
:tree_sha
. For example, settingrecursive
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.
get repos/[string owner]/[string repo]/hooks
List repository webhooks
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/hooks
function post repos/[string owner]/[string repo]/hooks(Repo_hooks_body payload) returns Hook|error
Create a repository webhook
Parameters
- payload Repo_hooks_body -
get repos/[string owner]/[string repo]/hooks/[int hook_id]
Get a repository webhook
delete repos/[string owner]/[string repo]/hooks/[int hook_id]
Delete a repository webhook
patch repos/[string owner]/[string repo]/hooks/[int hook_id]
function patch repos/[string owner]/[string repo]/hooks/[int hook_id](Hooks_hook_id_body_1 payload) returns Hook|error
Update a repository webhook
Parameters
- payload Hooks_hook_id_body_1 -
get repos/[string owner]/[string repo]/hooks/[int hook_id]/config
function get repos/[string owner]/[string repo]/hooks/[int hook_id]/config() returns WebhookConfig|error
Get a webhook configuration for a repository
Return Type
- WebhookConfig|error - Response
patch repos/[string owner]/[string repo]/hooks/[int hook_id]/config
function patch repos/[string owner]/[string repo]/hooks/[int hook_id]/config(Hook_id_config_body_1 payload) returns WebhookConfig|error
Update a webhook configuration for a repository
Parameters
- payload Hook_id_config_body_1 -
Return Type
- WebhookConfig|error - Response
get repos/[string owner]/[string repo]/hooks/[int hook_id]/deliveries
function get repos/[string owner]/[string repo]/hooks/[int hook_id]/deliveries(int per_page, string? cursor, boolean? redelivery) returns HookDeliveryItem[]|error
List deliveries for a repository webhook
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- cursor string? (default ()) - 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.
- redelivery boolean? (default ()) -
Return Type
- HookDeliveryItem[]|error - Response
get repos/[string owner]/[string repo]/hooks/[int hook_id]/deliveries/[int delivery_id]
function get repos/[string owner]/[string repo]/hooks/[int hook_id]/deliveries/[int delivery_id]() returns HookDelivery|error
Get a delivery for a repository webhook
Return Type
- HookDelivery|error - Response
post repos/[string owner]/[string repo]/hooks/[int hook_id]/deliveries/[int delivery_id]/attempts
function post repos/[string owner]/[string repo]/hooks/[int hook_id]/deliveries/[int delivery_id]/attempts() returns json|error
Redeliver a delivery for a repository webhook
Return Type
- json|error - Accepted
post repos/[string owner]/[string repo]/hooks/[int hook_id]/pings
Ping a repository webhook
post repos/[string owner]/[string repo]/hooks/[int hook_id]/tests
Test the push repository webhook
get repos/[string owner]/[string repo]/'import
Get an import status
put repos/[string owner]/[string repo]/'import
function put repos/[string owner]/[string repo]/'import(Repo_import_body payload) returns Import|error
Start an import
Parameters
- payload Repo_import_body -
delete repos/[string owner]/[string repo]/'import
Cancel an import
patch repos/[string owner]/[string repo]/'import
function patch repos/[string owner]/[string repo]/'import(Repo_import_body_1 payload) returns Import|error
Update an import
Parameters
- payload Repo_import_body_1 -
get repos/[string owner]/[string repo]/'import/authors
function get repos/[string owner]/[string repo]/'import/authors(int? since) returns PorterAuthor[]|error
Get commit authors
Parameters
- since int? (default ()) - A user ID. Only return users with an ID greater than this ID.
Return Type
- PorterAuthor[]|error - Response
patch repos/[string owner]/[string repo]/'import/authors/[int author_id]
function patch repos/[string owner]/[string repo]/'import/authors/[int author_id](Authors_author_id_body payload) returns PorterAuthor|error
Map a commit author
Parameters
- payload Authors_author_id_body -
Return Type
- PorterAuthor|error - Response
get repos/[string owner]/[string repo]/'import/large_files
function get repos/[string owner]/[string repo]/'import/large_files() returns PorterLargeFile[]|error
Get large files
Return Type
- PorterLargeFile[]|error - Response
patch repos/[string owner]/[string repo]/'import/lfs
function patch repos/[string owner]/[string repo]/'import/lfs(Import_lfs_body payload) returns Import|error
Update Git LFS preference
Parameters
- payload Import_lfs_body -
get repos/[string owner]/[string repo]/installation
function get repos/[string owner]/[string repo]/installation() returns Installation|error
Get a repository installation for the authenticated app
Return Type
- Installation|error - Response
get repos/[string owner]/[string repo]/interaction-limits
function get repos/[string owner]/[string repo]/interaction\-limits() returns InteractionLimitResponseAny|error
Get interaction restrictions for a repository
Return Type
- InteractionLimitResponseAny|error - Response
put repos/[string owner]/[string repo]/interaction-limits
function put repos/[string owner]/[string repo]/interaction\-limits(InteractionLimit payload) returns InteractionLimitResponse|error
Set interaction restrictions for a repository
Parameters
- payload InteractionLimit -
Return Type
- InteractionLimitResponse|error - Response
delete repos/[string owner]/[string repo]/interaction-limits
Remove interaction restrictions for a repository
get repos/[string owner]/[string repo]/invitations
function get repos/[string owner]/[string repo]/invitations(int per_page, int page) returns RepositoryInvitation[]|error
List repository invitations
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RepositoryInvitation[]|error - Response
delete repos/[string owner]/[string repo]/invitations/[int invitation_id]
function delete repos/[string owner]/[string repo]/invitations/[int invitation_id]() returns error?
Delete a repository invitation
Return Type
- error? - Response
patch repos/[string owner]/[string repo]/invitations/[int invitation_id]
function patch repos/[string owner]/[string repo]/invitations/[int invitation_id](Invitations_invitation_id_body payload) returns RepositoryInvitation|error
Update a repository invitation
Parameters
- payload Invitations_invitation_id_body -
Return Type
- RepositoryInvitation|error - Response
get repos/[string owner]/[string repo]/issues
function get repos/[string owner]/[string repo]/issues(string? milestone, "open"|"closed"|"all" state, string? assignee, string? creator, string? mentioned, string? labels, "created"|"updated"|"comments" sort, "asc"|"desc" direction, string? since, int per_page, int page) returns Issue[]|error
List repository issues
Parameters
- milestone string? (default ()) - If an
integer
is passed, it should refer to a milestone by itsnumber
field. If the string*
is passed, issues with any milestone are accepted. If the stringnone
is passed, issues without milestones are returned.
- state "open"|"closed"|"all" (default "open") - Indicates the state of the issues to return.
- assignee string? (default ()) - Can be the name of a user. Pass in
none
for issues with no assigned user, and*
for issues assigned to any user.
- creator string? (default ()) - The user that created the issue.
- mentioned string? (default ()) - A user that's mentioned in the issue.
- labels string? (default ()) - A list of comma separated label names. Example:
bug,ui,@high
- sort "created"|"updated"|"comments" (default "created") - What to sort results by.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/issues
function post repos/[string owner]/[string repo]/issues(Repo_issues_body payload) returns Issue|error
Create an issue
Parameters
- payload Repo_issues_body -
get repos/[string owner]/[string repo]/issues/comments
function get repos/[string owner]/[string repo]/issues/comments("created"|"updated" sort, "asc"|"desc"? direction, string? since, int per_page, int page) returns IssueComment[]|error
List issue comments for a repository
Parameters
- sort "created"|"updated" (default "created") - The property to sort the results by.
- direction "asc"|"desc"? (default ()) - Either
asc
ordesc
. Ignored without thesort
parameter.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- IssueComment[]|error - Response
get repos/[string owner]/[string repo]/issues/comments/[int comment_id]
function get repos/[string owner]/[string repo]/issues/comments/[int comment_id]() returns IssueComment|error
Get an issue comment
Return Type
- IssueComment|error - Response
delete repos/[string owner]/[string repo]/issues/comments/[int comment_id]
function delete repos/[string owner]/[string repo]/issues/comments/[int comment_id]() returns error?
Delete an issue comment
Return Type
- error? - Response
patch repos/[string owner]/[string repo]/issues/comments/[int comment_id]
function patch repos/[string owner]/[string repo]/issues/comments/[int comment_id](Comments_comment_id_body_2 payload) returns IssueComment|error
Update an issue comment
Parameters
- payload Comments_comment_id_body_2 -
Return Type
- IssueComment|error - Response
get repos/[string owner]/[string repo]/issues/comments/[int comment_id]/reactions
function get repos/[string owner]/[string repo]/issues/comments/[int comment_id]/reactions("+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? content, int per_page, int page) returns Reaction[]|error
List reactions for an issue comment
Parameters
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? (default ()) - Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/issues/comments/[int comment_id]/reactions
function post repos/[string owner]/[string repo]/issues/comments/[int comment_id]/reactions(Comment_id_reactions_body_1 payload) returns Reaction|error
Create reaction for an issue comment
Parameters
- payload Comment_id_reactions_body_1 -
delete repos/[string owner]/[string repo]/issues/comments/[int comment_id]/reactions/[int reaction_id]
function delete repos/[string owner]/[string repo]/issues/comments/[int comment_id]/reactions/[int reaction_id]() returns error?
Delete an issue comment reaction
Return Type
- error? - Response
get repos/[string owner]/[string repo]/issues/events
function get repos/[string owner]/[string repo]/issues/events(int per_page, int page) returns IssueEvent[]|error
List issue events for a repository
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- IssueEvent[]|error - Response
get repos/[string owner]/[string repo]/issues/events/[int event_id]
function get repos/[string owner]/[string repo]/issues/events/[int event_id]() returns IssueEvent|error
Get an issue event
Return Type
- IssueEvent|error - Response
get repos/[string owner]/[string repo]/issues/[int issue_number]
Get an issue
patch repos/[string owner]/[string repo]/issues/[int issue_number]
function patch repos/[string owner]/[string repo]/issues/[int issue_number](Issues_issue_number_body payload) returns Issue|error
Update an issue
Parameters
- payload Issues_issue_number_body -
post repos/[string owner]/[string repo]/issues/[int issue_number]/assignees
function post repos/[string owner]/[string repo]/issues/[int issue_number]/assignees(Issue_number_assignees_body payload) returns Issue|error
Add assignees to an issue
Parameters
- payload Issue_number_assignees_body -
delete repos/[string owner]/[string repo]/issues/[int issue_number]/assignees
function delete repos/[string owner]/[string repo]/issues/[int issue_number]/assignees(Issue_number_assignees_body_1 payload) returns Issue|error
Remove assignees from an issue
Parameters
- payload Issue_number_assignees_body_1 -
get repos/[string owner]/[string repo]/issues/[int issue_number]/assignees/[string assignee]
function get repos/[string owner]/[string repo]/issues/[int issue_number]/assignees/[string assignee]() returns Response|error
Check if a user can be assigned to a issue
get repos/[string owner]/[string repo]/issues/[int issue_number]/comments
function get repos/[string owner]/[string repo]/issues/[int issue_number]/comments(string? since, int per_page, int page) returns IssueComment[]|error
List issue comments
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- IssueComment[]|error - Response
post repos/[string owner]/[string repo]/issues/[int issue_number]/comments
function post repos/[string owner]/[string repo]/issues/[int issue_number]/comments(Issue_number_comments_body payload) returns IssueComment|error
Create an issue comment
Parameters
- payload Issue_number_comments_body -
Return Type
- IssueComment|error - Response
get repos/[string owner]/[string repo]/issues/[int issue_number]/events
function get repos/[string owner]/[string repo]/issues/[int issue_number]/events(int per_page, int page) returns IssueEventForIssue[]|error
List issue events
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- IssueEventForIssue[]|error - Response
get repos/[string owner]/[string repo]/issues/[int issue_number]/labels
function get repos/[string owner]/[string repo]/issues/[int issue_number]/labels(int per_page, int page) returns Label[]|error
List labels for an issue
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
put repos/[string owner]/[string repo]/issues/[int issue_number]/labels
function put repos/[string owner]/[string repo]/issues/[int issue_number]/labels(Issue_number_labels_body payload) returns Label[]|error
Set labels for an issue
Parameters
- payload Issue_number_labels_body -
post repos/[string owner]/[string repo]/issues/[int issue_number]/labels
function post repos/[string owner]/[string repo]/issues/[int issue_number]/labels(Issue_number_labels_body_1 payload) returns Label[]|error
Add labels to an issue
Parameters
- payload Issue_number_labels_body_1 -
delete repos/[string owner]/[string repo]/issues/[int issue_number]/labels
function delete repos/[string owner]/[string repo]/issues/[int issue_number]/labels() returns Response|error
Remove all labels from an issue
delete repos/[string owner]/[string repo]/issues/[int issue_number]/labels/[string name]
function delete repos/[string owner]/[string repo]/issues/[int issue_number]/labels/[string name]() returns Label[]|error
Remove a label from an issue
put repos/[string owner]/[string repo]/issues/[int issue_number]/'lock
function put repos/[string owner]/[string repo]/issues/[int issue_number]/'lock(Issue_number_lock_body payload) returns Response|error
Lock an issue
Parameters
- payload Issue_number_lock_body -
delete repos/[string owner]/[string repo]/issues/[int issue_number]/'lock
function delete repos/[string owner]/[string repo]/issues/[int issue_number]/'lock() returns Response|error
Unlock an issue
get repos/[string owner]/[string repo]/issues/[int issue_number]/reactions
function get repos/[string owner]/[string repo]/issues/[int issue_number]/reactions("+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? content, int per_page, int page) returns Reaction[]|error
List reactions for an issue
Parameters
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? (default ()) - Returns a single reaction type. Omit this parameter to list all reactions to an issue.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/issues/[int issue_number]/reactions
function post repos/[string owner]/[string repo]/issues/[int issue_number]/reactions(Issue_number_reactions_body payload) returns Reaction|error
Create reaction for an issue
Parameters
- payload Issue_number_reactions_body -
delete repos/[string owner]/[string repo]/issues/[int issue_number]/reactions/[int reaction_id]
function delete repos/[string owner]/[string repo]/issues/[int issue_number]/reactions/[int reaction_id]() returns error?
Delete an issue reaction
Return Type
- error? - Response
get repos/[string owner]/[string repo]/issues/[int issue_number]/timeline
function get repos/[string owner]/[string repo]/issues/[int issue_number]/timeline(int per_page, int page) returns TimelineIssueEvents[]|error
List timeline events for an issue
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- TimelineIssueEvents[]|error - Response
get repos/[string owner]/[string repo]/keys
function get repos/[string owner]/[string repo]/keys(int per_page, int page) returns DeployKey[]|error
List deploy keys
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/keys
function post repos/[string owner]/[string repo]/keys(Repo_keys_body payload) returns DeployKey|error
Create a deploy key
Parameters
- payload Repo_keys_body -
get repos/[string owner]/[string repo]/keys/[int key_id]
Get a deploy key
delete repos/[string owner]/[string repo]/keys/[int key_id]
function delete repos/[string owner]/[string repo]/keys/[int key_id]() returns error?
Delete a deploy key
Return Type
- error? - Response
get repos/[string owner]/[string repo]/labels
function get repos/[string owner]/[string repo]/labels(int per_page, int page) returns Label[]|error
List labels for a repository
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/labels
function post repos/[string owner]/[string repo]/labels(Repo_labels_body payload) returns Label|error
Create a label
Parameters
- payload Repo_labels_body -
get repos/[string owner]/[string repo]/labels/[string name]
Get a label
delete repos/[string owner]/[string repo]/labels/[string name]
function delete repos/[string owner]/[string repo]/labels/[string name]() returns error?
Delete a label
Return Type
- error? - Response
patch repos/[string owner]/[string repo]/labels/[string name]
function patch repos/[string owner]/[string repo]/labels/[string name](Labels_name_body payload) returns Label|error
Update a label
Parameters
- payload Labels_name_body -
get repos/[string owner]/[string repo]/languages
List repository languages
get repos/[string owner]/[string repo]/license
function get repos/[string owner]/[string repo]/license() returns LicenseContent|error
Get the license for a repository
Return Type
- LicenseContent|error - Response
post repos/[string owner]/[string repo]/merge-upstream
function post repos/[string owner]/[string repo]/merge\-upstream(Repo_mergeupstream_body payload) returns MergedUpstream|error
Sync a fork branch with the upstream repository
Parameters
- payload Repo_mergeupstream_body -
Return Type
- MergedUpstream|error - The branch has been successfully synced with the upstream repository
post repos/[string owner]/[string repo]/merges
function post repos/[string owner]/[string repo]/merges(Repo_merges_body payload) returns Commit|error
Merge a branch
Parameters
- payload Repo_merges_body -
get repos/[string owner]/[string repo]/milestones
function get repos/[string owner]/[string repo]/milestones("open"|"closed"|"all" state, "due_on"|"completeness" sort, "asc"|"desc" direction, int per_page, int page) returns Milestone[]|error
List milestones
Parameters
- state "open"|"closed"|"all" (default "open") - The state of the milestone. Either
open
,closed
, orall
.
- sort "due_on"|"completeness" (default "due_on") - What to sort results by. Either
due_on
orcompleteness
.
- direction "asc"|"desc" (default "asc") - The direction of the sort. Either
asc
ordesc
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/milestones
function post repos/[string owner]/[string repo]/milestones(Repo_milestones_body payload) returns Milestone|error
Create a milestone
Parameters
- payload Repo_milestones_body -
get repos/[string owner]/[string repo]/milestones/[int milestone_number]
function get repos/[string owner]/[string repo]/milestones/[int milestone_number]() returns Milestone|error
Get a milestone
delete repos/[string owner]/[string repo]/milestones/[int milestone_number]
function delete repos/[string owner]/[string repo]/milestones/[int milestone_number]() returns Response|error
Delete a milestone
patch repos/[string owner]/[string repo]/milestones/[int milestone_number]
function patch repos/[string owner]/[string repo]/milestones/[int milestone_number](Milestones_milestone_number_body payload) returns Milestone|error
Update a milestone
Parameters
- payload Milestones_milestone_number_body -
get repos/[string owner]/[string repo]/milestones/[int milestone_number]/labels
function get repos/[string owner]/[string repo]/milestones/[int milestone_number]/labels(int per_page, int page) returns Label[]|error
List labels for issues in a milestone
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get repos/[string owner]/[string repo]/notifications
function get repos/[string owner]/[string repo]/notifications(boolean all, boolean participating, string? since, string? before, int per_page, int page) returns NotificationThread[]|error
List repository notifications for the authenticated user
Parameters
- all boolean (default false) - If
true
, show notifications marked as read.
- participating boolean (default false) - If
true
, only shows notifications in which the user is directly participating or mentioned.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- NotificationThread[]|error - Response
put repos/[string owner]/[string repo]/notifications
function put repos/[string owner]/[string repo]/notifications(Repo_notifications_body payload) returns NotificationRead|error?
Mark repository notifications as read
Parameters
- payload Repo_notifications_body -
Return Type
- NotificationRead|error? - Response
get repos/[string owner]/[string repo]/pages
Get a GitHub Pages site
put repos/[string owner]/[string repo]/pages
function put repos/[string owner]/[string repo]/pages(Repo_pages_body payload) returns Response|error
Update information about a GitHub Pages site
Parameters
- payload Repo_pages_body -
post repos/[string owner]/[string repo]/pages
function post repos/[string owner]/[string repo]/pages(Repo_pages_body_1 payload) returns Page|error
Create a GitHub Pages site
Parameters
- payload Repo_pages_body_1 -
delete repos/[string owner]/[string repo]/pages
Delete a GitHub Pages site
get repos/[string owner]/[string repo]/pages/builds
function get repos/[string owner]/[string repo]/pages/builds(int per_page, int page) returns PageBuild[]|error
List GitHub Pages builds
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/pages/builds
function post repos/[string owner]/[string repo]/pages/builds() returns PageBuildStatus|error
Request a GitHub Pages build
Return Type
- PageBuildStatus|error - Response
get repos/[string owner]/[string repo]/pages/builds/latest
Get latest Pages build
get repos/[string owner]/[string repo]/pages/builds/[int build_id]
function get repos/[string owner]/[string repo]/pages/builds/[int build_id]() returns PageBuild|error
Get GitHub Pages build
post repos/[string owner]/[string repo]/pages/deployment
function post repos/[string owner]/[string repo]/pages/deployment(Pages_deployment_body payload) returns PageDeployment|error
Create a GitHub Pages deployment
Parameters
- payload Pages_deployment_body -
Return Type
- PageDeployment|error - Response
get repos/[string owner]/[string repo]/pages/health
function get repos/[string owner]/[string repo]/pages/health() returns PagesHealthCheck|EmptyObject|error
Get a DNS health check for GitHub Pages
Return Type
- PagesHealthCheck|EmptyObject|error - Response
put repos/[string owner]/[string repo]/private-vulnerability-reporting
function put repos/[string owner]/[string repo]/private\-vulnerability\-reporting() returns Response|error
Enable private vulnerability reporting for a repository
delete repos/[string owner]/[string repo]/private-vulnerability-reporting
function delete repos/[string owner]/[string repo]/private\-vulnerability\-reporting() returns Response|error
Disable private vulnerability reporting for a repository
get repos/[string owner]/[string repo]/projects
function get repos/[string owner]/[string repo]/projects("open"|"closed"|"all" state, int per_page, int page) returns Project[]|error
List repository projects
Parameters
- state "open"|"closed"|"all" (default "open") - Indicates the state of the projects to return.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/projects
function post repos/[string owner]/[string repo]/projects(Repo_projects_body payload) returns Project|error
Create a repository project
Parameters
- payload Repo_projects_body -
get repos/[string owner]/[string repo]/pulls
function get repos/[string owner]/[string repo]/pulls("open"|"closed"|"all" state, string? head, string? base, "created"|"updated"|"popularity"|"long-running" sort, "asc"|"desc"? direction, int per_page, int page) returns PullRequestSimple[]|error
List pull requests
Parameters
- state "open"|"closed"|"all" (default "open") - Either
open
,closed
, orall
to filter by state.
- head string? (default ()) - Filter pulls by head user or head organization and branch name in the format of
user:ref-name
ororganization:ref-name
. For example:github:new-script-format
oroctocat:test-branch
.
- base string? (default ()) - Filter pulls by base branch name. Example:
gh-pages
.
- sort "created"|"updated"|"popularity"|"long-running" (default "created") - 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.
- direction "asc"|"desc"? (default ()) - The direction of the sort. Default:
desc
when sort iscreated
or sort is not specified, otherwiseasc
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- PullRequestSimple[]|error - Response
post repos/[string owner]/[string repo]/pulls
function post repos/[string owner]/[string repo]/pulls(Repo_pulls_body payload) returns PullRequest|error
Create a pull request
Parameters
- payload Repo_pulls_body -
Return Type
- PullRequest|error - Response
get repos/[string owner]/[string repo]/pulls/comments
function get repos/[string owner]/[string repo]/pulls/comments("created"|"updated"|"created_at"? sort, "asc"|"desc"? direction, string? since, int per_page, int page) returns PullRequestReviewComment[]|error
List review comments in a repository
Parameters
- sort "created"|"updated"|"created_at"? (default ()) -
- direction "asc"|"desc"? (default ()) - The direction to sort results. Ignored without
sort
parameter.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- PullRequestReviewComment[]|error - Response
get repos/[string owner]/[string repo]/pulls/comments/[int comment_id]
function get repos/[string owner]/[string repo]/pulls/comments/[int comment_id]() returns PullRequestReviewComment|error
Get a review comment for a pull request
Return Type
- PullRequestReviewComment|error - Response
delete repos/[string owner]/[string repo]/pulls/comments/[int comment_id]
function delete repos/[string owner]/[string repo]/pulls/comments/[int comment_id]() returns Response|error
Delete a review comment for a pull request
patch repos/[string owner]/[string repo]/pulls/comments/[int comment_id]
function patch repos/[string owner]/[string repo]/pulls/comments/[int comment_id](Comments_comment_id_body_3 payload) returns PullRequestReviewComment|error
Update a review comment for a pull request
Parameters
- payload Comments_comment_id_body_3 -
Return Type
- PullRequestReviewComment|error - Response
get repos/[string owner]/[string repo]/pulls/comments/[int comment_id]/reactions
function get repos/[string owner]/[string repo]/pulls/comments/[int comment_id]/reactions("+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? content, int per_page, int page) returns Reaction[]|error
List reactions for a pull request review comment
Parameters
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? (default ()) - Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/pulls/comments/[int comment_id]/reactions
function post repos/[string owner]/[string repo]/pulls/comments/[int comment_id]/reactions(Comment_id_reactions_body_2 payload) returns Reaction|error
Create reaction for a pull request review comment
Parameters
- payload Comment_id_reactions_body_2 -
delete repos/[string owner]/[string repo]/pulls/comments/[int comment_id]/reactions/[int reaction_id]
function delete repos/[string owner]/[string repo]/pulls/comments/[int comment_id]/reactions/[int reaction_id]() returns error?
Delete a pull request comment reaction
Return Type
- error? - Response
get repos/[string owner]/[string repo]/pulls/[int pull_number]
function get repos/[string owner]/[string repo]/pulls/[int pull_number]() returns PullRequest|error
Get a pull request
Return Type
- PullRequest|error - Pass the appropriate media type to fetch diff and patch formats.
patch repos/[string owner]/[string repo]/pulls/[int pull_number]
function patch repos/[string owner]/[string repo]/pulls/[int pull_number](Pulls_pull_number_body payload) returns PullRequest|error
Update a pull request
Parameters
- payload Pulls_pull_number_body -
Return Type
- PullRequest|error - Response
post repos/[string owner]/[string repo]/pulls/[int pull_number]/codespaces
function post repos/[string owner]/[string repo]/pulls/[int pull_number]/codespaces(Pull_number_codespaces_body payload) returns Codespace|error
Create a codespace from a pull request
Parameters
- payload Pull_number_codespaces_body -
get repos/[string owner]/[string repo]/pulls/[int pull_number]/comments
function get repos/[string owner]/[string repo]/pulls/[int pull_number]/comments("created"|"updated" sort, "asc"|"desc"? direction, string? since, int per_page, int page) returns PullRequestReviewComment[]|error
List review comments on a pull request
Parameters
- sort "created"|"updated" (default "created") - The property to sort the results by.
- direction "asc"|"desc"? (default ()) - The direction to sort results. Ignored without
sort
parameter.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- PullRequestReviewComment[]|error - Response
post repos/[string owner]/[string repo]/pulls/[int pull_number]/comments
function post repos/[string owner]/[string repo]/pulls/[int pull_number]/comments(Pull_number_comments_body payload) returns PullRequestReviewComment|error
Create a review comment for a pull request
Parameters
- payload Pull_number_comments_body -
Return Type
- PullRequestReviewComment|error - Response
post repos/[string owner]/[string repo]/pulls/[int pull_number]/comments/[int comment_id]/replies
function post repos/[string owner]/[string repo]/pulls/[int pull_number]/comments/[int comment_id]/replies(Comment_id_replies_body payload) returns PullRequestReviewComment|error
Create a reply for a review comment
Parameters
- payload Comment_id_replies_body -
Return Type
- PullRequestReviewComment|error - Response
get repos/[string owner]/[string repo]/pulls/[int pull_number]/commits
function get repos/[string owner]/[string repo]/pulls/[int pull_number]/commits(int per_page, int page) returns Commit[]|error
List commits on a pull request
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get repos/[string owner]/[string repo]/pulls/[int pull_number]/files
function get repos/[string owner]/[string repo]/pulls/[int pull_number]/files(int per_page, int page) returns DiffEntry[]|error
List pull requests files
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get repos/[string owner]/[string repo]/pulls/[int pull_number]/merge
function get repos/[string owner]/[string repo]/pulls/[int pull_number]/merge() returns Response|error
Check if a pull request has been merged
put repos/[string owner]/[string repo]/pulls/[int pull_number]/merge
function put repos/[string owner]/[string repo]/pulls/[int pull_number]/merge(Pull_number_merge_body payload) returns PullRequestMergeResult|error
Merge a pull request
Parameters
- payload Pull_number_merge_body -
Return Type
- PullRequestMergeResult|error - if merge was successful
get repos/[string owner]/[string repo]/pulls/[int pull_number]/requested_reviewers
function get repos/[string owner]/[string repo]/pulls/[int pull_number]/requested_reviewers() returns PullRequestReviewRequest|error
Get all requested reviewers for a pull request
Return Type
- PullRequestReviewRequest|error - Response
post repos/[string owner]/[string repo]/pulls/[int pull_number]/requested_reviewers
function post repos/[string owner]/[string repo]/pulls/[int pull_number]/requested_reviewers(Pull_number_requested_reviewers_body payload) returns PullRequestSimple|error
Request reviewers for a pull request
Parameters
- payload Pull_number_requested_reviewers_body -
Return Type
- PullRequestSimple|error - Response
delete repos/[string owner]/[string repo]/pulls/[int pull_number]/requested_reviewers
function delete repos/[string owner]/[string repo]/pulls/[int pull_number]/requested_reviewers(Pull_number_requested_reviewers_body_1 payload) returns PullRequestSimple|error
Remove requested reviewers from a pull request
Parameters
- payload Pull_number_requested_reviewers_body_1 -
Return Type
- PullRequestSimple|error - Response
get repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews
function get repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews(int per_page, int page) returns PullRequestReview[]|error
List reviews for a pull request
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- PullRequestReview[]|error - The list of reviews returns in chronological order.
post repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews
function post repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews(Pull_number_reviews_body payload) returns PullRequestReview|error
Create a review for a pull request
Parameters
- payload Pull_number_reviews_body -
Return Type
- PullRequestReview|error - Response
get repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]
function get repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]() returns PullRequestReview|error
Get a review for a pull request
Return Type
- PullRequestReview|error - Response
put repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]
function put repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id](Reviews_review_id_body payload) returns PullRequestReview|error
Update a review for a pull request
Parameters
- payload Reviews_review_id_body -
Return Type
- PullRequestReview|error - Response
delete repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]
function delete repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]() returns PullRequestReview|error
Delete a pending review for a pull request
Return Type
- PullRequestReview|error - Response
get repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]/comments
function get repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]/comments(int per_page, int page) returns ReviewComment[]|error
List comments for a pull request review
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ReviewComment[]|error - Response
put repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]/dismissals
function put repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]/dismissals(Review_id_dismissals_body payload) returns PullRequestReview|error
Dismiss a review for a pull request
Parameters
- payload Review_id_dismissals_body -
Return Type
- PullRequestReview|error - Response
post repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]/events
function post repos/[string owner]/[string repo]/pulls/[int pull_number]/reviews/[int review_id]/events(Review_id_events_body payload) returns PullRequestReview|error
Submit a review for a pull request
Parameters
- payload Review_id_events_body -
Return Type
- PullRequestReview|error - Response
put repos/[string owner]/[string repo]/pulls/[int pull_number]/update-branch
function put repos/[string owner]/[string repo]/pulls/[int pull_number]/update\-branch(Pull_number_updatebranch_body payload) returns NotificationRead|error
Update a pull request branch
Parameters
- payload Pull_number_updatebranch_body -
Return Type
- NotificationRead|error - Response
get repos/[string owner]/[string repo]/readme
function get repos/[string owner]/[string repo]/readme(string? ref) returns ContentFile|error
Get a repository README
Parameters
- ref string? (default ()) - The name of the commit/branch/tag. Default: the repository’s default branch.
Return Type
- ContentFile|error - Response
get repos/[string owner]/[string repo]/readme/[string dir]
function get repos/[string owner]/[string repo]/readme/[string dir](string? ref) returns ContentFile|error
Get a repository README for a directory
Parameters
- ref string? (default ()) - The name of the commit/branch/tag. Default: the repository’s default branch.
Return Type
- ContentFile|error - Response
get repos/[string owner]/[string repo]/releases
function get repos/[string owner]/[string repo]/releases(int per_page, int page) returns Release[]|error
List releases
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/releases
function post repos/[string owner]/[string repo]/releases(Repo_releases_body payload) returns Release|error
Create a release
Parameters
- payload Repo_releases_body -
get repos/[string owner]/[string repo]/releases/assets/[int asset_id]
function get repos/[string owner]/[string repo]/releases/assets/[int asset_id]() returns ReleaseAsset|error?
Get a release asset
Return Type
- ReleaseAsset|error? - Response
delete repos/[string owner]/[string repo]/releases/assets/[int asset_id]
function delete repos/[string owner]/[string repo]/releases/assets/[int asset_id]() returns error?
Delete a release asset
Return Type
- error? - Response
patch repos/[string owner]/[string repo]/releases/assets/[int asset_id]
function patch repos/[string owner]/[string repo]/releases/assets/[int asset_id](Assets_asset_id_body payload) returns ReleaseAsset|error
Update a release asset
Parameters
- payload Assets_asset_id_body -
Return Type
- ReleaseAsset|error - Response
post repos/[string owner]/[string repo]/releases/generate-notes
function post repos/[string owner]/[string repo]/releases/generate\-notes(Releases_generatenotes_body payload) returns ReleaseNotesContent|error
Generate release notes content for a release
Parameters
- payload Releases_generatenotes_body -
Return Type
- ReleaseNotesContent|error - Name and body of generated release notes
get repos/[string owner]/[string repo]/releases/latest
Get the latest release
get repos/[string owner]/[string repo]/releases/tags/[string tag]
Get a release by tag name
get repos/[string owner]/[string repo]/releases/[int release_id]
Get a release
Return Type
- Release|error - Note: This returns an
upload_url
key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
delete repos/[string owner]/[string repo]/releases/[int release_id]
function delete repos/[string owner]/[string repo]/releases/[int release_id]() returns error?
Delete a release
Return Type
- error? - Response
patch repos/[string owner]/[string repo]/releases/[int release_id]
function patch repos/[string owner]/[string repo]/releases/[int release_id](Releases_release_id_body payload) returns Release|error
Update a release
Parameters
- payload Releases_release_id_body -
get repos/[string owner]/[string repo]/releases/[int release_id]/assets
function get repos/[string owner]/[string repo]/releases/[int release_id]/assets(int per_page, int page) returns ReleaseAsset[]|error
List release assets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ReleaseAsset[]|error - Response
post repos/[string owner]/[string repo]/releases/[int release_id]/assets
function post repos/[string owner]/[string repo]/releases/[int release_id]/assets(string name, byte[] payload, string? label) returns ReleaseAsset|error
Upload a release asset
Return Type
- ReleaseAsset|error - Response for successful upload
get repos/[string owner]/[string repo]/releases/[int release_id]/reactions
function get repos/[string owner]/[string repo]/releases/[int release_id]/reactions("+1"|"laugh"|"heart"|"hooray"|"rocket"|"eyes"? content, int per_page, int page) returns Reaction[]|error
List reactions for a release
Parameters
- content "+1"|"laugh"|"heart"|"hooray"|"rocket"|"eyes"? (default ()) - Returns a single reaction type. Omit this parameter to list all reactions to a release.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post repos/[string owner]/[string repo]/releases/[int release_id]/reactions
function post repos/[string owner]/[string repo]/releases/[int release_id]/reactions(Release_id_reactions_body payload) returns Reaction|error
Create reaction for a release
Parameters
- payload Release_id_reactions_body -
delete repos/[string owner]/[string repo]/releases/[int release_id]/reactions/[int reaction_id]
function delete repos/[string owner]/[string repo]/releases/[int release_id]/reactions/[int reaction_id]() returns error?
Delete a release reaction
Return Type
- error? - Response
get repos/[string owner]/[string repo]/rules/branches/[string branch]
function get repos/[string owner]/[string repo]/rules/branches/[string branch](int per_page, int page) returns RepositoryRuleDetailed[]|error
Get rules for a branch
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RepositoryRuleDetailed[]|error - Response
get repos/[string owner]/[string repo]/rulesets
function get repos/[string owner]/[string repo]/rulesets(int per_page, int page, boolean includes_parents) returns RepositoryRuleset[]|error
Get all repository rulesets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- includes_parents boolean (default true) - Include rulesets configured at higher levels that apply to this repository
Return Type
- RepositoryRuleset[]|error - Response
post repos/[string owner]/[string repo]/rulesets
function post repos/[string owner]/[string repo]/rulesets(Repo_rulesets_body payload) returns RepositoryRuleset|error
Create a repository ruleset
Parameters
- payload Repo_rulesets_body - Request body
Return Type
- RepositoryRuleset|error - Response
get repos/[string owner]/[string repo]/rulesets/rule-suites
function get repos/[string owner]/[string repo]/rulesets/rule\-suites(string? ref, "hour"|"day"|"week"|"month" time_period, string? actor_name, "pass"|"fail"|"bypass"|"all" rule_suite_result, int per_page, int page) returns RuleSuites|error
List repository rule suites
Parameters
- ref string? (default ()) - The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned.
- time_period "hour"|"day"|"week"|"month" (default "day") - The time period to filter by.
For example,
day
will filter for rule suites that occurred in the past 24 hours, andweek
will filter for insights that occurred in the past 7 days (168 hours).
- actor_name string? (default ()) - The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.
- rule_suite_result "pass"|"fail"|"bypass"|"all" (default "all") - The rule results to filter on. When specified, only suites with this result will be returned.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RuleSuites|error - Response
get repos/[string owner]/[string repo]/rulesets/rule-suites/[int rule_suite_id]
function get repos/[string owner]/[string repo]/rulesets/rule\-suites/[int rule_suite_id]() returns RuleSuite|error
Get a repository rule suite
get repos/[string owner]/[string repo]/rulesets/[int ruleset_id]
function get repos/[string owner]/[string repo]/rulesets/[int ruleset_id](boolean includes_parents) returns RepositoryRuleset|error
Get a repository ruleset
Parameters
- includes_parents boolean (default true) - Include rulesets configured at higher levels that apply to this repository
Return Type
- RepositoryRuleset|error - Response
put repos/[string owner]/[string repo]/rulesets/[int ruleset_id]
function put repos/[string owner]/[string repo]/rulesets/[int ruleset_id](Rulesets_ruleset_id_body_1 payload) returns RepositoryRuleset|error
Update a repository ruleset
Parameters
- payload Rulesets_ruleset_id_body_1 - Request body
Return Type
- RepositoryRuleset|error - Response
delete repos/[string owner]/[string repo]/rulesets/[int ruleset_id]
function delete repos/[string owner]/[string repo]/rulesets/[int ruleset_id]() returns Response|error
Delete a repository ruleset
get repos/[string owner]/[string repo]/secret-scanning/alerts
function get repos/[string owner]/[string repo]/secret\-scanning/alerts("open"|"resolved"? state, string? secret_type, string? resolution, "created"|"updated" sort, "asc"|"desc" direction, int page, int per_page, string? before, string? after) returns SecretScanningAlert[]|error
List secret scanning alerts for a repository
Parameters
- state "open"|"resolved"? (default ()) - Set to
open
orresolved
to only list secret scanning alerts in a specific state.
- secret_type string? (default ()) - A comma-separated list of secret types to return. By default all secret types are returned. See "Secret scanning patterns" for a complete list of secret types.
- resolution string? (default ()) - 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
orused_in_tests
.
- sort "created"|"updated" (default "created") - The property to sort the results by.
created
means when the alert was created.updated
means when the alert was updated or resolved.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
- before string? (default ()) - A cursor, as given in the Link header. 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.
- after string? (default ()) - A cursor, as given in the Link header. 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.
Return Type
- SecretScanningAlert[]|error - Response
get repos/[string owner]/[string repo]/secret-scanning/alerts/[AlertNumber alert_number]
function get repos/[string owner]/[string repo]/secret\-scanning/alerts/[AlertNumber alert_number]() returns SecretScanningAlert|error
Get a secret scanning alert
Return Type
- SecretScanningAlert|error - Response
patch repos/[string owner]/[string repo]/secret-scanning/alerts/[AlertNumber alert_number]
function patch repos/[string owner]/[string repo]/secret\-scanning/alerts/[AlertNumber alert_number](Alerts_alert_number_body_2 payload) returns SecretScanningAlert|error
Update a secret scanning alert
Parameters
- payload Alerts_alert_number_body_2 -
Return Type
- SecretScanningAlert|error - Response
get repos/[string owner]/[string repo]/secret-scanning/alerts/[AlertNumber alert_number]/locations
function get repos/[string owner]/[string repo]/secret\-scanning/alerts/[AlertNumber alert_number]/locations(int page, int per_page) returns SecretScanningLocation[]|error
List locations for a secret scanning alert
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- SecretScanningLocation[]|error - Response
get repos/[string owner]/[string repo]/security-advisories
function get repos/[string owner]/[string repo]/security\-advisories("asc"|"desc" direction, "created"|"updated"|"published" sort, string? before, string? after, int per_page, "triage"|"draft"|"published"|"closed"? state) returns RepositoryAdvisory[]|error
List repository security advisories
Parameters
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- sort "created"|"updated"|"published" (default "created") - The property to sort the results by.
- before string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
- after string? (default ()) - A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
- per_page int (default 30) - Number of advisories to return per page.
- state "triage"|"draft"|"published"|"closed"? (default ()) - Filter by state of the repository advisories. Only advisories of this state will be returned.
Return Type
- RepositoryAdvisory[]|error - Response
post repos/[string owner]/[string repo]/security-advisories
function post repos/[string owner]/[string repo]/security\-advisories(RepositoryAdvisoryCreate payload) returns RepositoryAdvisory|error
Create a repository security advisory
Parameters
- payload RepositoryAdvisoryCreate -
Return Type
- RepositoryAdvisory|error - Response
post repos/[string owner]/[string repo]/security-advisories/reports
function post repos/[string owner]/[string repo]/security\-advisories/reports(PrivateVulnerabilityReportCreate payload) returns RepositoryAdvisory|error
Privately report a security vulnerability
Parameters
- payload PrivateVulnerabilityReportCreate -
Return Type
- RepositoryAdvisory|error - Response
get repos/[string owner]/[string repo]/security-advisories/[string ghsa_id]
function get repos/[string owner]/[string repo]/security\-advisories/[string ghsa_id]() returns RepositoryAdvisory|error
Get a repository security advisory
Return Type
- RepositoryAdvisory|error - Response
patch repos/[string owner]/[string repo]/security-advisories/[string ghsa_id]
function patch repos/[string owner]/[string repo]/security\-advisories/[string ghsa_id](RepositoryAdvisoryUpdate payload) returns RepositoryAdvisory|error
Update a repository security advisory
Parameters
- payload RepositoryAdvisoryUpdate -
Return Type
- RepositoryAdvisory|error - Response
post repos/[string owner]/[string repo]/security-advisories/[string ghsa_id]/cve
function post repos/[string owner]/[string repo]/security\-advisories/[string ghsa_id]/cve() returns json|error
Request a CVE for a repository security advisory
Return Type
- json|error - Accepted
get repos/[string owner]/[string repo]/stargazers
function get repos/[string owner]/[string repo]/stargazers(int per_page, int page) returns StargazerResponse|error
List stargazers
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- StargazerResponse|error - Response
get repos/[string owner]/[string repo]/stats/code_frequency
function get repos/[string owner]/[string repo]/stats/code_frequency() returns json|CodeFrequencyStat[]|error?
Get the weekly commit activity
Return Type
- json|CodeFrequencyStat[]|error? - Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
get repos/[string owner]/[string repo]/stats/commit_activity
function get repos/[string owner]/[string repo]/stats/commit_activity() returns json|CommitActivity[]|error?
Get the last year of commit activity
Return Type
- json|CommitActivity[]|error? - Response
get repos/[string owner]/[string repo]/stats/contributors
function get repos/[string owner]/[string repo]/stats/contributors() returns json|ContributorActivity[]|error?
Get all contributor commit activity
Return Type
- json|ContributorActivity[]|error? - Response
get repos/[string owner]/[string repo]/stats/participation
function get repos/[string owner]/[string repo]/stats/participation() returns ParticipationStats|error
Get the weekly commit count
Return Type
- ParticipationStats|error - The array order is oldest week (index 0) to most recent week.
get repos/[string owner]/[string repo]/stats/punch_card
function get repos/[string owner]/[string repo]/stats/punch_card() returns CodeFrequencyStat[]|error?
Get the hourly commit count for each day
Return Type
- CodeFrequencyStat[]|error? - For 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.
post repos/[string owner]/[string repo]/statuses/[string sha]
function post repos/[string owner]/[string repo]/statuses/[string sha](Statuses_sha_body payload) returns Status|error
Create a commit status
Parameters
- payload Statuses_sha_body -
get repos/[string owner]/[string repo]/subscribers
function get repos/[string owner]/[string repo]/subscribers(int per_page, int page) returns SimpleUser[]|error
List watchers
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get repos/[string owner]/[string repo]/subscription
function get repos/[string owner]/[string repo]/subscription() returns RepositorySubscription|error
Get a repository subscription
Return Type
- RepositorySubscription|error - if you subscribe to the repository
put repos/[string owner]/[string repo]/subscription
function put repos/[string owner]/[string repo]/subscription(Repo_subscription_body payload) returns RepositorySubscription|error
Set a repository subscription
Parameters
- payload Repo_subscription_body -
Return Type
- RepositorySubscription|error - Response
delete repos/[string owner]/[string repo]/subscription
function delete repos/[string owner]/[string repo]/subscription() returns error?
Delete a repository subscription
Return Type
- error? - Response
get repos/[string owner]/[string repo]/tags
List repository tags
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get repos/[string owner]/[string repo]/tags/protection
function get repos/[string owner]/[string repo]/tags/protection() returns TagProtection[]|error
List tag protection states for a repository
Return Type
- TagProtection[]|error - Response
post repos/[string owner]/[string repo]/tags/protection
function post repos/[string owner]/[string repo]/tags/protection(Tags_protection_body payload) returns TagProtection|error
Create a tag protection state for a repository
Parameters
- payload Tags_protection_body -
Return Type
- TagProtection|error - Response
delete repos/[string owner]/[string repo]/tags/protection/[int tag_protection_id]
function delete repos/[string owner]/[string repo]/tags/protection/[int tag_protection_id]() returns Response|error
Delete a tag protection state for a repository
get repos/[string owner]/[string repo]/tarball/[string ref]
function get repos/[string owner]/[string repo]/tarball/[string ref]() returns error?
Download a repository archive (tar)
Return Type
- error? - Response
get repos/[string owner]/[string repo]/teams
List repository teams
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get repos/[string owner]/[string repo]/topics
Get all repository topics
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
put repos/[string owner]/[string repo]/topics
function put repos/[string owner]/[string repo]/topics(Repo_topics_body payload) returns Topic|error
Replace all repository topics
Parameters
- payload Repo_topics_body -
get repos/[string owner]/[string repo]/traffic/clones
function get repos/[string owner]/[string repo]/traffic/clones("day"|"week" per) returns CloneTraffic|error
Get repository clones
Parameters
- per "day"|"week" (default "day") - The time frame to display results for.
Return Type
- CloneTraffic|error - Response
get repos/[string owner]/[string repo]/traffic/popular/paths
function get repos/[string owner]/[string repo]/traffic/popular/paths() returns ContentTraffic[]|error
Get top referral paths
Return Type
- ContentTraffic[]|error - Response
get repos/[string owner]/[string repo]/traffic/popular/referrers
function get repos/[string owner]/[string repo]/traffic/popular/referrers() returns ReferrerTraffic[]|error
Get top referral sources
Return Type
- ReferrerTraffic[]|error - Response
get repos/[string owner]/[string repo]/traffic/views
function get repos/[string owner]/[string repo]/traffic/views("day"|"week" per) returns ViewTraffic|error
Get page views
Parameters
- per "day"|"week" (default "day") - The time frame to display results for.
Return Type
- ViewTraffic|error - Response
post repos/[string owner]/[string repo]/transfer
function post repos/[string owner]/[string repo]/transfer(Repo_transfer_body payload) returns MinimalRepository|error
Transfer a repository
Parameters
- payload Repo_transfer_body -
Return Type
- MinimalRepository|error - Response
get repos/[string owner]/[string repo]/vulnerability-alerts
Check if vulnerability alerts are enabled for a repository
put repos/[string owner]/[string repo]/vulnerability-alerts
function put repos/[string owner]/[string repo]/vulnerability\-alerts() returns error?
Enable vulnerability alerts
Return Type
- error? - Response
delete repos/[string owner]/[string repo]/vulnerability-alerts
function delete repos/[string owner]/[string repo]/vulnerability\-alerts() returns error?
Disable vulnerability alerts
Return Type
- error? - Response
get repos/[string owner]/[string repo]/zipball/[string ref]
function get repos/[string owner]/[string repo]/zipball/[string ref]() returns error?
Download a repository archive (zip)
Return Type
- error? - Response
post repos/[string template_owner]/[string template_repo]/generate
function post repos/[string template_owner]/[string template_repo]/generate(Template_repo_generate_body payload) returns Repository|error
Create a repository using a template
Parameters
- payload Template_repo_generate_body -
Return Type
- Repository|error - Response
get repositories
function get repositories(int? since) returns MinimalRepository[]|error?
List public repositories
Parameters
- since int? (default ()) - A repository ID. Only return repositories with an ID greater than this ID.
Return Type
- MinimalRepository[]|error? - Response
get repositories/[int repository_id]/environments/[string environment_name]/secrets
function get repositories/[int repository_id]/environments/[string environment_name]/secrets(int per_page, int page) returns ActionsSecretResponse|error
List environment secrets
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ActionsSecretResponse|error - Response
get repositories/[int repository_id]/environments/[string environment_name]/secrets/public-key
function get repositories/[int repository_id]/environments/[string environment_name]/secrets/public\-key() returns ActionsPublicKey|error
Get an environment public key
Return Type
- ActionsPublicKey|error - Response
get repositories/[int repository_id]/environments/[string environment_name]/secrets/[string secret_name]
function get repositories/[int repository_id]/environments/[string environment_name]/secrets/[string secret_name]() returns ActionsSecret|error
Get an environment secret
Return Type
- ActionsSecret|error - Response
put repositories/[int repository_id]/environments/[string environment_name]/secrets/[string secret_name]
function put repositories/[int repository_id]/environments/[string environment_name]/secrets/[string secret_name](Secrets_secret_name_body_6 payload) returns EmptyObject|error?
Create or update an environment secret
Parameters
- payload Secrets_secret_name_body_6 -
Return Type
- EmptyObject|error? - Response when creating a secret
delete repositories/[int repository_id]/environments/[string environment_name]/secrets/[string secret_name]
function delete repositories/[int repository_id]/environments/[string environment_name]/secrets/[string secret_name]() returns error?
Delete an environment secret
Return Type
- error? - Default response
get repositories/[int repository_id]/environments/[string environment_name]/variables
function get repositories/[int repository_id]/environments/[string environment_name]/variables(int per_page, int page) returns ActionsVariableResponse|error
List environment variables
Parameters
- per_page int (default 10) - The number of results per page (max 30).
- page int (default 1) - Page number of the results to fetch.
Return Type
- ActionsVariableResponse|error - Response
post repositories/[int repository_id]/environments/[string environment_name]/variables
function post repositories/[int repository_id]/environments/[string environment_name]/variables(Environment_name_variables_body payload) returns EmptyObject|error
Create an environment variable
Parameters
- payload Environment_name_variables_body -
Return Type
- EmptyObject|error - Response
get repositories/[int repository_id]/environments/[string environment_name]/variables/[string name]
function get repositories/[int repository_id]/environments/[string environment_name]/variables/[string name]() returns ActionsVariable|error
Get an environment variable
Return Type
- ActionsVariable|error - Response
delete repositories/[int repository_id]/environments/[string environment_name]/variables/[string name]
function delete repositories/[int repository_id]/environments/[string environment_name]/variables/[string name]() returns error?
Delete an environment variable
Return Type
- error? - Response
patch repositories/[int repository_id]/environments/[string environment_name]/variables/[string name]
function patch repositories/[int repository_id]/environments/[string environment_name]/variables/[string name](Variables_name_body_2 payload) returns error?
Update an environment variable
Parameters
- payload Variables_name_body_2 -
Return Type
- error? - Response
get search/code
function get search/code(string q, "indexed"? sort, "desc"|"asc" 'order, int per_page, int page) returns CodeSearchResultItemResponse|error
Search code
Parameters
- q string - The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.
- sort "indexed"? (default ()) - This field is deprecated. Sorts the results of your query. Can only be
indexed
, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match
- 'order "desc"|"asc" (default "desc") - This field is deprecated. 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 providesort
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Deprecated parameters
Return Type
- CodeSearchResultItemResponse|error - Response
get search/commits
function get search/commits(string q, "author-date"|"committer-date"? sort, "desc"|"asc" 'order, int per_page, int page) returns CommitSearchResultItemResponse|error?
Search commits
Parameters
- q string - The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.
- sort "author-date"|"committer-date"? (default ()) - Sorts the results of your query by
author-date
orcommitter-date
. Default: best match
- 'order "desc"|"asc" (default "desc") - 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 providesort
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CommitSearchResultItemResponse|error? - Response
get search/issues
function get search/issues(string q, "comments"|"reactions"|"reactions-+1"|"reactions--1"|"reactions-smile"|"reactions-thinking_face"|"reactions-heart"|"reactions-tada"|"interactions"|"created"|"updated"? sort, "desc"|"asc" 'order, int per_page, int page) returns IssueSearchResultItemResponse|error
Search issues and pull requests
Parameters
- q string - The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.
- sort "comments"|"reactions"|"reactions-+1"|"reactions--1"|"reactions-smile"|"reactions-thinking_face"|"reactions-heart"|"reactions-tada"|"interactions"|"created"|"updated"? (default ()) - 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
, orinteractions
. You can also sort results by how recently the items werecreated
orupdated
, Default: best match
- 'order "desc"|"asc" (default "desc") - 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 providesort
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- IssueSearchResultItemResponse|error - Response
get search/labels
function get search/labels(int repository_id, string q, "created"|"updated"? sort, "desc"|"asc" 'order, int per_page, int page) returns LabelSearchResultItemResponse|error
Search labels
Parameters
- repository_id int - The id of the repository.
- q string - 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.
- sort "created"|"updated"? (default ()) - Sorts the results of your query by when the label was
created
orupdated
. Default: best match
- 'order "desc"|"asc" (default "desc") - 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 providesort
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- LabelSearchResultItemResponse|error - Response
get search/repositories
function get search/repositories(string q, "stars"|"forks"|"help-wanted-issues"|"updated"? sort, "desc"|"asc" 'order, int per_page, int page) returns RepoSearchResultItemResponse|error?
Search repositories
Parameters
- q string - The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.
- sort "stars"|"forks"|"help-wanted-issues"|"updated"? (default ()) - Sorts the results of your query by number of
stars
,forks
, orhelp-wanted-issues
or how recently the items wereupdated
. Default: best match
- 'order "desc"|"asc" (default "desc") - 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 providesort
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RepoSearchResultItemResponse|error? - Response
get search/topics
function get search/topics(string q, int per_page, int page) returns TopicSearchResultItemResponse|error?
Search topics
Parameters
- q string - The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- TopicSearchResultItemResponse|error? - Response
get search/users
function get search/users(string q, "followers"|"repositories"|"joined"? sort, "desc"|"asc" 'order, int per_page, int page) returns UserSearchResultItemResponse|error
Search users
Parameters
- q string - The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.
- sort "followers"|"repositories"|"joined"? (default ()) - Sorts the results of your query by number of
followers
orrepositories
, or when the personjoined
GitHub. Default: best match
- 'order "desc"|"asc" (default "desc") - 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 providesort
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- UserSearchResultItemResponse|error - Response
get teams/[int team_id]
Get a team (Legacy)
delete teams/[int team_id]
Delete a team (Legacy)
patch teams/[int team_id]
function patch teams/[int team_id](Teams_team_id_body payload) returns TeamFull|error
Update a team (Legacy)
Parameters
- payload Teams_team_id_body -
get teams/[int team_id]/discussions
function get teams/[int team_id]/discussions("asc"|"desc" direction, int per_page, int page) returns TeamDiscussion[]|error
List discussions (Legacy)
Parameters
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- TeamDiscussion[]|error - Response
Deprecated
post teams/[int team_id]/discussions
function post teams/[int team_id]/discussions(Team_id_discussions_body payload) returns TeamDiscussion|error
Create a discussion (Legacy)
Parameters
- payload Team_id_discussions_body -
Return Type
- TeamDiscussion|error - Response
Deprecated
get teams/[int team_id]/discussions/[int discussion_number]
function get teams/[int team_id]/discussions/[int discussion_number]() returns TeamDiscussion|error
Get a discussion (Legacy)
Return Type
- TeamDiscussion|error - Response
Deprecated
delete teams/[int team_id]/discussions/[int discussion_number]
function delete teams/[int team_id]/discussions/[int discussion_number]() returns error?
Delete a discussion (Legacy)
Return Type
- error? - Response
Deprecated
patch teams/[int team_id]/discussions/[int discussion_number]
function patch teams/[int team_id]/discussions/[int discussion_number](Discussions_discussion_number_body_1 payload) returns TeamDiscussion|error
Update a discussion (Legacy)
Parameters
- payload Discussions_discussion_number_body_1 -
Return Type
- TeamDiscussion|error - Response
Deprecated
get teams/[int team_id]/discussions/[int discussion_number]/comments
function get teams/[int team_id]/discussions/[int discussion_number]/comments("asc"|"desc" direction, int per_page, int page) returns TeamDiscussionComment[]|error
List discussion comments (Legacy)
Parameters
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- TeamDiscussionComment[]|error - Response
Deprecated
post teams/[int team_id]/discussions/[int discussion_number]/comments
function post teams/[int team_id]/discussions/[int discussion_number]/comments(Discussion_number_comments_body_1 payload) returns TeamDiscussionComment|error
Create a discussion comment (Legacy)
Parameters
- payload Discussion_number_comments_body_1 -
Return Type
- TeamDiscussionComment|error - Response
Deprecated
get teams/[int team_id]/discussions/[int discussion_number]/comments/[int comment_number]
function get teams/[int team_id]/discussions/[int discussion_number]/comments/[int comment_number]() returns TeamDiscussionComment|error
Get a discussion comment (Legacy)
Return Type
- TeamDiscussionComment|error - Response
Deprecated
delete teams/[int team_id]/discussions/[int discussion_number]/comments/[int comment_number]
function delete teams/[int team_id]/discussions/[int discussion_number]/comments/[int comment_number]() returns error?
Delete a discussion comment (Legacy)
Return Type
- error? - Response
Deprecated
patch teams/[int team_id]/discussions/[int discussion_number]/comments/[int comment_number]
function patch teams/[int team_id]/discussions/[int discussion_number]/comments/[int comment_number](Comments_comment_number_body_1 payload) returns TeamDiscussionComment|error
Update a discussion comment (Legacy)
Parameters
- payload Comments_comment_number_body_1 -
Return Type
- TeamDiscussionComment|error - Response
Deprecated
get teams/[int team_id]/discussions/[int discussion_number]/comments/[int comment_number]/reactions
function get teams/[int team_id]/discussions/[int discussion_number]/comments/[int comment_number]/reactions("+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? content, int per_page, int page) returns Reaction[]|error
List reactions for a team discussion comment (Legacy)
Parameters
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? (default ()) - Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post teams/[int team_id]/discussions/[int discussion_number]/comments/[int comment_number]/reactions
function post teams/[int team_id]/discussions/[int discussion_number]/comments/[int comment_number]/reactions(Comment_number_reactions_body_1 payload) returns Reaction|error
Create reaction for a team discussion comment (Legacy)
Parameters
- payload Comment_number_reactions_body_1 -
get teams/[int team_id]/discussions/[int discussion_number]/reactions
function get teams/[int team_id]/discussions/[int discussion_number]/reactions("+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? content, int per_page, int page) returns Reaction[]|error
List reactions for a team discussion (Legacy)
Parameters
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes"? (default ()) - Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post teams/[int team_id]/discussions/[int discussion_number]/reactions
function post teams/[int team_id]/discussions/[int discussion_number]/reactions(Discussion_number_reactions_body_1 payload) returns Reaction|error
Create reaction for a team discussion (Legacy)
Parameters
- payload Discussion_number_reactions_body_1 -
get teams/[int team_id]/invitations
function get teams/[int team_id]/invitations(int per_page, int page) returns OrganizationInvitation[]|error
List pending team invitations (Legacy)
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- OrganizationInvitation[]|error - Response
Deprecated
get teams/[int team_id]/members
function get teams/[int team_id]/members("member"|"maintainer"|"all" role, int per_page, int page) returns SimpleUser[]|error
List team members (Legacy)
Parameters
- role "member"|"maintainer"|"all" (default "all") - Filters members returned by their role in the team.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
Deprecated
get teams/[int team_id]/members/[string username]
Get team member (Legacy)
put teams/[int team_id]/members/[string username]
Add team member (Legacy)
delete teams/[int team_id]/members/[string username]
Remove team member (Legacy)
get teams/[int team_id]/memberships/[string username]
function get teams/[int team_id]/memberships/[string username]() returns TeamMembership|error
Get team membership for a user (Legacy)
Return Type
- TeamMembership|error - Response
Deprecated
put teams/[int team_id]/memberships/[string username]
function put teams/[int team_id]/memberships/[string username](Memberships_username_body_2 payload) returns TeamMembership|error
Add or update team membership for a user (Legacy)
Parameters
- payload Memberships_username_body_2 -
Return Type
- TeamMembership|error - Response
Deprecated
delete teams/[int team_id]/memberships/[string username]
Remove team membership for a user (Legacy)
get teams/[int team_id]/projects
function get teams/[int team_id]/projects(int per_page, int page) returns TeamProject[]|error
List team projects (Legacy)
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- TeamProject[]|error - Response
Deprecated
get teams/[int team_id]/projects/[int project_id]
function get teams/[int team_id]/projects/[int project_id]() returns TeamProject|error
Check team permissions for a project (Legacy)
Return Type
- TeamProject|error - Response
Deprecated
put teams/[int team_id]/projects/[int project_id]
function put teams/[int team_id]/projects/[int project_id](Projects_project_id_body_2 payload) returns Response|error
Add or update team project permissions (Legacy)
Parameters
- payload Projects_project_id_body_2 -
delete teams/[int team_id]/projects/[int project_id]
Remove a project from a team (Legacy)
get teams/[int team_id]/repos
function get teams/[int team_id]/repos(int per_page, int page) returns MinimalRepository[]|error
List team repositories (Legacy)
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Response
Deprecated
get teams/[int team_id]/repos/[string owner]/[string repo]
function get teams/[int team_id]/repos/[string owner]/[string repo]() returns TeamRepository|error
Check team permissions for a repository (Legacy)
Return Type
- TeamRepository|error - Alternative response with extra repository information
Deprecated
put teams/[int team_id]/repos/[string owner]/[string repo]
function put teams/[int team_id]/repos/[string owner]/[string repo](Owner_repo_body_2 payload) returns Response|error
Add or update team repository permissions (Legacy)
Parameters
- payload Owner_repo_body_2 -
delete teams/[int team_id]/repos/[string owner]/[string repo]
function delete teams/[int team_id]/repos/[string owner]/[string repo]() returns error?
Remove a repository from a team (Legacy)
Return Type
- error? - Response
Deprecated
get teams/[int team_id]/teams
List child teams (Legacy)
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get user
function get user() returns UserResponse|error
Get the authenticated user
Return Type
- UserResponse|error - Response
patch user
function patch user(User_body payload) returns PrivateUser|error
Update the authenticated user
Parameters
- payload User_body -
Return Type
- PrivateUser|error - Response
get user/blocks
function get user/blocks(int per_page, int page) returns SimpleUser[]|error
List users blocked by the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get user/blocks/[string username]
Check if a user is blocked by the authenticated user
put user/blocks/[string username]
Block a user
delete user/blocks/[string username]
Unblock a user
get user/codespaces
function get user/codespaces(int per_page, int page, int? repository_id) returns CodespaceResponse|error
List codespaces for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
- repository_id int? (default ()) - ID of the Repository to filter on
Return Type
- CodespaceResponse|error - Response
post user/codespaces
function post user/codespaces(User_codespaces_body payload) returns Codespace|error
Create a codespace for the authenticated user
Parameters
- payload User_codespaces_body -
get user/codespaces/secrets
function get user/codespaces/secrets(int per_page, int page) returns CodespacesSecretResponse|error
List secrets for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- CodespacesSecretResponse|error - Response
get user/codespaces/secrets/public-key
function get user/codespaces/secrets/public\-key() returns CodespacesUserPublicKey|error
Get public key for the authenticated user
Return Type
- CodespacesUserPublicKey|error - Response
get user/codespaces/secrets/[string secret_name]
function get user/codespaces/secrets/[string secret_name]() returns CodespacesSecret|error
Get a secret for the authenticated user
Return Type
- CodespacesSecret|error - Response
put user/codespaces/secrets/[string secret_name]
function put user/codespaces/secrets/[string secret_name](Secrets_secret_name_body_7 payload) returns EmptyObject|error
Create or update a secret for the authenticated user
Parameters
- payload Secrets_secret_name_body_7 -
Return Type
- EmptyObject|error - Response after successfully creating a secret
delete user/codespaces/secrets/[string secret_name]
function delete user/codespaces/secrets/[string secret_name]() returns error?
Delete a secret for the authenticated user
Return Type
- error? - Response
get user/codespaces/secrets/[string secret_name]/repositories
function get user/codespaces/secrets/[string secret_name]/repositories() returns MinimalRepositoryResponse|error
List selected repositories for a user secret
Return Type
- MinimalRepositoryResponse|error - Response
put user/codespaces/secrets/[string secret_name]/repositories
function put user/codespaces/secrets/[string secret_name]/repositories(Secret_name_repositories_body_3 payload) returns Response|error
Set selected repositories for a user secret
Parameters
- payload Secret_name_repositories_body_3 -
put user/codespaces/secrets/[string secret_name]/repositories/[int repository_id]
function put user/codespaces/secrets/[string secret_name]/repositories/[int repository_id]() returns Response|error
Add a selected repository to a user secret
delete user/codespaces/secrets/[string secret_name]/repositories/[int repository_id]
function delete user/codespaces/secrets/[string secret_name]/repositories/[int repository_id]() returns Response|error
Remove a selected repository from a user secret
get user/codespaces/[string codespace_name]
Get a codespace for the authenticated user
delete user/codespaces/[string codespace_name]
function delete user/codespaces/[string codespace_name]() returns json|error
Delete a codespace for the authenticated user
Return Type
- json|error - Accepted
patch user/codespaces/[string codespace_name]
function patch user/codespaces/[string codespace_name](Codespaces_codespace_name_body payload) returns Codespace|error
Update a codespace for the authenticated user
Parameters
- payload Codespaces_codespace_name_body -
post user/codespaces/[string codespace_name]/exports
function post user/codespaces/[string codespace_name]/exports() returns CodespaceExportDetails|error
Export a codespace for the authenticated user
Return Type
- CodespaceExportDetails|error - Response
get user/codespaces/[string codespace_name]/exports/[string export_id]
function get user/codespaces/[string codespace_name]/exports/[string export_id]() returns CodespaceExportDetails|error
Get details about a codespace export
Return Type
- CodespaceExportDetails|error - Response
get user/codespaces/[string codespace_name]/machines
function get user/codespaces/[string codespace_name]/machines() returns CodespaceMachineResponse|error
List machine types for a codespace
Return Type
- CodespaceMachineResponse|error - Response
post user/codespaces/[string codespace_name]/publish
function post user/codespaces/[string codespace_name]/publish(Codespace_name_publish_body payload) returns CodespaceWithFullRepository|error
Create a repository from an unpublished codespace
Parameters
- payload Codespace_name_publish_body -
Return Type
- CodespaceWithFullRepository|error - Response
post user/codespaces/[string codespace_name]/'start
Start a codespace for the authenticated user
post user/codespaces/[string codespace_name]/stop
Stop a codespace for the authenticated user
get user/docker/conflicts
Get list of conflicting packages during Docker migration for authenticated-user
patch user/email/visibility
function patch user/email/visibility(Email_visibility_body payload) returns Email[]|error
Set primary email visibility for the authenticated user
Parameters
- payload Email_visibility_body -
get user/emails
List email addresses for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post user/emails
function post user/emails(User_emails_body payload) returns Email[]|error
Add an email address for the authenticated user
Parameters
- payload User_emails_body -
delete user/emails
function delete user/emails(User_emails_body_1 payload) returns Response|error
Delete an email address for the authenticated user
Parameters
- payload User_emails_body_1 -
get user/followers
function get user/followers(int per_page, int page) returns SimpleUser[]|error
List followers of the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get user/following
function get user/following(int per_page, int page) returns SimpleUser[]|error
List the people the authenticated user follows
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get user/following/[string username]
Check if a person is followed by the authenticated user
put user/following/[string username]
Follow a user
delete user/following/[string username]
Unfollow a user
get user/gpg_keys
List GPG keys for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post user/gpg_keys
function post user/gpg_keys(User_gpg_keys_body payload) returns GpgKey|error
Create a GPG key for the authenticated user
Parameters
- payload User_gpg_keys_body -
get user/gpg_keys/[int gpg_key_id]
Get a GPG key for the authenticated user
delete user/gpg_keys/[int gpg_key_id]
Delete a GPG key for the authenticated user
get user/installations
function get user/installations(int per_page, int page) returns InstallationResponse|error
List app installations accessible to the user access token
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- InstallationResponse|error - You can find the permissions for the installation under the
permissions
key.
get user/installations/[int installation_id]/repositories
function get user/installations/[int installation_id]/repositories(int per_page, int page) returns RepositoryResponse|error?
List repositories accessible to the user access token
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RepositoryResponse|error? - The access the user has to each repository is included in the hash under the
permissions
key.
put user/installations/[int installation_id]/repositories/[int repository_id]
function put user/installations/[int installation_id]/repositories/[int repository_id]() returns Response|error
Add a repository to an app installation
delete user/installations/[int installation_id]/repositories/[int repository_id]
function delete user/installations/[int installation_id]/repositories/[int repository_id]() returns Response|error
Remove a repository from an app installation
get user/interaction-limits
function get user/interaction\-limits() returns InteractionLimitResponseAny|error?
Get interaction restrictions for your public repositories
Return Type
- InteractionLimitResponseAny|error? - Default response
put user/interaction-limits
function put user/interaction\-limits(InteractionLimit payload) returns InteractionLimitResponse|error
Set interaction restrictions for your public repositories
Parameters
- payload InteractionLimit -
Return Type
- InteractionLimitResponse|error - Response
delete user/interaction-limits
function delete user/interaction\-limits() returns error?
Remove interaction restrictions from your public repositories
Return Type
- error? - Response
get user/issues
function get user/issues("assigned"|"created"|"mentioned"|"subscribed"|"repos"|"all" filter, "open"|"closed"|"all" state, string? labels, "created"|"updated"|"comments" sort, "asc"|"desc" direction, string? since, int per_page, int page) returns Issue[]|error?
List user account issues assigned to the authenticated user
Parameters
- filter "assigned"|"created"|"mentioned"|"subscribed"|"repos"|"all" (default "assigned") - 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
orrepos
means all issues you can see, regardless of participation or creation.
- state "open"|"closed"|"all" (default "open") - Indicates the state of the issues to return.
- labels string? (default ()) - A list of comma separated label names. Example:
bug,ui,@high
- sort "created"|"updated"|"comments" (default "created") - What to sort results by.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get user/keys
List public SSH keys for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post user/keys
function post user/keys(User_keys_body payload) returns Key|error
Create a public SSH key for the authenticated user
Parameters
- payload User_keys_body -
get user/keys/[int key_id]
Get a public SSH key for the authenticated user
delete user/keys/[int key_id]
Delete a public SSH key for the authenticated user
get user/marketplace_purchases
function get user/marketplace_purchases(int per_page, int page) returns UserMarketplacePurchase[]|error
List subscriptions for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- UserMarketplacePurchase[]|error - Response
get user/marketplace_purchases/stubbed
function get user/marketplace_purchases/stubbed(int per_page, int page) returns UserMarketplacePurchase[]|error
List subscriptions for the authenticated user (stubbed)
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- UserMarketplacePurchase[]|error - Response
get user/memberships/orgs
function get user/memberships/orgs("active"|"pending"? state, int per_page, int page) returns OrgMembership[]|error
List organization memberships for the authenticated user
Parameters
- state "active"|"pending"? (default ()) - Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- OrgMembership[]|error - Response
get user/memberships/orgs/[string org]
function get user/memberships/orgs/[string org]() returns OrgMembership|error
Get an organization membership for the authenticated user
Return Type
- OrgMembership|error - Response
patch user/memberships/orgs/[string org]
function patch user/memberships/orgs/[string org](Orgs_org_body_1 payload) returns OrgMembership|error
Update an organization membership for the authenticated user
Parameters
- payload Orgs_org_body_1 -
Return Type
- OrgMembership|error - Response
get user/migrations
List user migrations
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
post user/migrations
function post user/migrations(User_migrations_body payload) returns Migration|error
Start a user migration
Parameters
- payload User_migrations_body -
get user/migrations/[int migration_id]
Get a user migration status
Parameters
- exclude string[]? (default ()) -
get user/migrations/[int migration_id]/archive
Download a user migration archive
delete user/migrations/[int migration_id]/archive
Delete a user migration archive
delete user/migrations/[int migration_id]/repos/[string repo_name]/'lock
function delete user/migrations/[int migration_id]/repos/[string repo_name]/'lock() returns Response|error
Unlock a user repository
get user/migrations/[int migration_id]/repositories
function get user/migrations/[int migration_id]/repositories(int per_page, int page) returns MinimalRepository[]|error
List repositories for a user migration
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Response
get user/orgs
function get user/orgs(int per_page, int page) returns OrganizationSimple[]|error
List organizations for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- OrganizationSimple[]|error - Response
get user/packages
function get user/packages("npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type, "public"|"private"|"internal"? visibility, int page, int per_page) returns Package[]|error
List packages for the authenticated user's namespace
Parameters
- package_type "npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" - 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 typecontainer
. You can use the typedocker
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.
- visibility "public"|"private"|"internal"? (default ()) - The selected visibility of the packages. This parameter is optional and only filters an existing result set.
The
internal
visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystemsinternal
is synonymous withprivate
. For the list of GitHub Packages registries that support granular permissions, see "About permissions for GitHub Packages."
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
get user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]
function get user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]() returns Package|error
Get a package for the authenticated user
delete user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]
function delete user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]() returns Response|error
Delete a package for the authenticated user
post user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/restore
function post user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/restore(string? token) returns Response|error
Restore a package for the authenticated user
Parameters
- token string? (default ()) - package token
get user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions
function get user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions(int page, int per_page, "active"|"deleted" state) returns PackageVersion[]|error
List package versions for a package owned by the authenticated user
Parameters
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
- state "active"|"deleted" (default "active") - The state of the package, either active or deleted.
Return Type
- PackageVersion[]|error - Response
get user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]
function get user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]() returns PackageVersion|error
Get a package version for the authenticated user
Return Type
- PackageVersion|error - Response
delete user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]
function delete user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]() returns Response|error
Delete a package version for the authenticated user
post user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]/restore
function post user/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]/restore() returns Response|error
Restore a package version for the authenticated user
post user/projects
function post user/projects(User_projects_body payload) returns Project|error
Create a user project
Parameters
- payload User_projects_body -
get user/public_emails
List public email addresses for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get user/repos
function get user/repos("all"|"public"|"private"? visibility, string? affiliation, "all"|"owner"|"public"|"private"|"member"? 'type, "created"|"updated"|"pushed"|"full_name"? sort, "asc"|"desc"? direction, int per_page, int page, string? since, string? before) returns Repository[]|error
List repositories for the authenticated user
Parameters
- visibility "all"|"public"|"private"? (default "all") - Limit results to repositories with the specified visibility.
- affiliation string? (default "owner,collaborator,organization_member") - Comma-separated list of values. Can include:
owner
: Repositories that are owned by the authenticated user.collaborator
: Repositories that the user has been added to as a collaborator.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.
- 'type "all"|"owner"|"public"|"private"|"member"? (default "all") - Limit results to repositories of the specified type. Will cause a
422
error if used in the same request as visibility or affiliation.
- sort "created"|"updated"|"pushed"|"full_name"? (default "full_name") - The property to sort the results by.
- direction "asc"|"desc"? (default ()) - The order to sort by. Default:
asc
when usingfull_name
, otherwisedesc
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- Repository[]|error - Response
post user/repos
function post user/repos(User_repos_body payload) returns Repository|error
Create a repository for the authenticated user
Parameters
- payload User_repos_body -
Return Type
- Repository|error - Response
get user/repository_invitations
function get user/repository_invitations(int per_page, int page) returns RepositoryInvitation[]|error
List repository invitations for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- RepositoryInvitation[]|error - Response
delete user/repository_invitations/[int invitation_id]
Decline a repository invitation
patch user/repository_invitations/[int invitation_id]
function patch user/repository_invitations/[int invitation_id]() returns error?
Accept a repository invitation
Return Type
- error? - Response
get user/social_accounts
function get user/social_accounts(int per_page, int page) returns SocialAccount[]|error
List social accounts for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SocialAccount[]|error - Response
post user/social_accounts
function post user/social_accounts(User_social_accounts_body payload) returns SocialAccount[]|error
Add social accounts for the authenticated user
Parameters
- payload User_social_accounts_body -
Return Type
- SocialAccount[]|error - Response
delete user/social_accounts
function delete user/social_accounts(User_social_accounts_body_1 payload) returns Response|error
Delete social accounts for the authenticated user
Parameters
- payload User_social_accounts_body_1 -
get user/ssh_signing_keys
function get user/ssh_signing_keys(int per_page, int page) returns SshSigningKey[]|error
List SSH signing keys for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SshSigningKey[]|error - Response
post user/ssh_signing_keys
function post user/ssh_signing_keys(User_ssh_signing_keys_body payload) returns SshSigningKey|error
Create a SSH signing key for the authenticated user
Parameters
- payload User_ssh_signing_keys_body -
Return Type
- SshSigningKey|error - Response
get user/ssh_signing_keys/[int ssh_signing_key_id]
function get user/ssh_signing_keys/[int ssh_signing_key_id]() returns SshSigningKey|error
Get an SSH signing key for the authenticated user
Return Type
- SshSigningKey|error - Response
delete user/ssh_signing_keys/[int ssh_signing_key_id]
Delete an SSH signing key for the authenticated user
get user/starred
function get user/starred("created"|"updated" sort, "asc"|"desc" direction, int per_page, int page) returns Repository[]|error
List repositories starred by the authenticated user
Parameters
- sort "created"|"updated" (default "created") - The property to sort the results by.
created
means when the repository was starred.updated
means when the repository was last pushed to.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- Repository[]|error - Response
get user/starred/[string owner]/[string repo]
Check if a repository is starred by the authenticated user
put user/starred/[string owner]/[string repo]
function put user/starred/[string owner]/[string repo]() returns error?
Star a repository for the authenticated user
Return Type
- error? - Response
delete user/starred/[string owner]/[string repo]
Unstar a repository for the authenticated user
get user/subscriptions
function get user/subscriptions(int per_page, int page) returns MinimalRepository[]|error
List repositories watched by the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Response
get user/teams
List teams for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get users
function get users(int? since, int per_page) returns SimpleUser[]|error?
List users
Parameters
- since int? (default ()) - A user ID. Only return users with an ID greater than this ID.
- per_page int (default 30) - The number of results per page (max 100).
Return Type
- SimpleUser[]|error? - Response
get users/[string username]
function get users/[string username]() returns UserResponse|error
Get a user
Return Type
- UserResponse|error - Response
get users/[string username]/docker/conflicts
Get list of conflicting packages during Docker migration for user
get users/[string username]/events
List events for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get users/[string username]/events/orgs/[string org]
function get users/[string username]/events/orgs/[string org](int per_page, int page) returns Event[]|error
List organization events for the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get users/[string username]/events/'public
List public events for a user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get users/[string username]/followers
function get users/[string username]/followers(int per_page, int page) returns SimpleUser[]|error
List followers of a user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get users/[string username]/following
function get users/[string username]/following(int per_page, int page) returns SimpleUser[]|error
List the people a user follows
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SimpleUser[]|error - Response
get users/[string username]/following/[string target_user]
Check if a user follows another user
get users/[string username]/gists
function get users/[string username]/gists(string? since, int per_page, int page) returns BaseGist[]|error
List gists for a user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get users/[string username]/gpg_keys
List GPG keys for a user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get users/[string username]/hovercard
function get users/[string username]/hovercard("organization"|"repository"|"issue"|"pull_request"? subject_type, string? subject_id) returns Hovercard|error
Get contextual information for a user
Parameters
- subject_type "organization"|"repository"|"issue"|"pull_request"? (default ()) - Identifies which additional information you'd like to receive about the person's hovercard. Can be
organization
,repository
,issue
,pull_request
. Required when usingsubject_id
.
- subject_id string? (default ()) - Uses the ID for the
subject_type
you specified. Required when usingsubject_type
.
get users/[string username]/installation
function get users/[string username]/installation() returns Installation|error
Get a user installation for the authenticated app
Return Type
- Installation|error - Response
get users/[string username]/keys
List public keys for a user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get users/[string username]/orgs
function get users/[string username]/orgs(int per_page, int page) returns OrganizationSimple[]|error
List organizations for a user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- OrganizationSimple[]|error - Response
get users/[string username]/packages
function get users/[string username]/packages("npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type, "public"|"private"|"internal"? visibility, int page, int per_page) returns Package[]|error
List packages for a user
Parameters
- package_type "npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" - 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 typecontainer
. You can use the typedocker
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.
- visibility "public"|"private"|"internal"? (default ()) - The selected visibility of the packages. This parameter is optional and only filters an existing result set.
The
internal
visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystemsinternal
is synonymous withprivate
. For the list of GitHub Packages registries that support granular permissions, see "About permissions for GitHub Packages."
- page int (default 1) - Page number of the results to fetch.
- per_page int (default 30) - The number of results per page (max 100).
get users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]
function get users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]() returns Package|error
Get a package for a user
delete users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]
function delete users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]() returns Response|error
Delete a package for a user
post users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/restore
function post users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/restore(string? token) returns Response|error
Restore a package for a user
Parameters
- token string? (default ()) - package token
get users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions
function get users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions() returns PackageVersion[]|error
List package versions for a package owned by a user
Return Type
- PackageVersion[]|error - Response
get users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]
function get users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]() returns PackageVersion|error
Get a package version for a user
Return Type
- PackageVersion|error - Response
delete users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]
function delete users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]() returns Response|error
Delete package version for a user
post users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]/restore
function post users/[string username]/packages/["npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" package_type]/[string package_name]/versions/[int package_version_id]/restore() returns Response|error
Restore package version for a user
get users/[string username]/projects
function get users/[string username]/projects("open"|"closed"|"all" state, int per_page, int page) returns Project[]|error
List user projects
Parameters
- state "open"|"closed"|"all" (default "open") - Indicates the state of the projects to return.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get users/[string username]/received_events
List events received by the authenticated user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get users/[string username]/received_events/'public
function get users/[string username]/received_events/'public(int per_page, int page) returns Event[]|error
List public events received by a user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
get users/[string username]/repos
function get users/[string username]/repos("all"|"owner"|"member" 'type, "created"|"updated"|"pushed"|"full_name" sort, "asc"|"desc"? direction, int per_page, int page) returns MinimalRepository[]|error
List repositories for a user
Parameters
- 'type "all"|"owner"|"member" (default "owner") - Limit results to repositories of the specified type.
- sort "created"|"updated"|"pushed"|"full_name" (default "full_name") - The property to sort the results by.
- direction "asc"|"desc"? (default ()) - The order to sort by. Default:
asc
when usingfull_name
, otherwisedesc
.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Response
get users/[string username]/settings/billing/actions
function get users/[string username]/settings/billing/actions() returns ActionsBillingUsage|error
Get GitHub Actions billing for a user
Return Type
- ActionsBillingUsage|error - Response
get users/[string username]/settings/billing/packages
function get users/[string username]/settings/billing/packages() returns PackagesBillingUsage|error
Get GitHub Packages billing for a user
Return Type
- PackagesBillingUsage|error - Response
get users/[string username]/settings/billing/shared-storage
function get users/[string username]/settings/billing/shared\-storage() returns CombinedBillingUsage|error
Get shared storage billing for a user
Return Type
- CombinedBillingUsage|error - Response
get users/[string username]/social_accounts
function get users/[string username]/social_accounts(int per_page, int page) returns SocialAccount[]|error
List social accounts for a user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SocialAccount[]|error - Response
get users/[string username]/ssh_signing_keys
function get users/[string username]/ssh_signing_keys(int per_page, int page) returns SshSigningKey[]|error
List SSH signing keys for a user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- SshSigningKey[]|error - Response
get users/[string username]/starred
function get users/[string username]/starred("created"|"updated" sort, "asc"|"desc" direction, int per_page, int page) returns StarredRepositoryResponse|error
List repositories starred by a user
Parameters
- sort "created"|"updated" (default "created") - The property to sort the results by.
created
means when the repository was starred.updated
means when the repository was last pushed to.
- direction "asc"|"desc" (default "desc") - The direction to sort the results by.
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- StarredRepositoryResponse|error - Response
get users/[string username]/subscriptions
function get users/[string username]/subscriptions(int per_page, int page) returns MinimalRepository[]|error
List repositories watched by a user
Parameters
- per_page int (default 30) - The number of results per page (max 100).
- page int (default 1) - Page number of the results to fetch.
Return Type
- MinimalRepository[]|error - Response
get versions
Get all API versions
get zen
Get the Zen of GitHub
Records
github: Access_selected_users_body
Fields
- selected_usernames string[] - The usernames of the organization members whose codespaces be billed to the organization.
github: Access_selected_users_body_1
Fields
- selected_usernames string[] - The usernames of the organization members whose codespaces should not be billed to the organization.
github: Actions_permissions_body
Fields
- enabled_repositories EnabledRepositories - The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
- allowed_actions AllowedActions? - The permissions policy that controls the actions and reusable workflows that are allowed to run.
github: Actions_permissions_body_1
Fields
- enabled ActionsEnabled - Whether GitHub Actions is enabled on the repository.
- allowed_actions AllowedActions? - The permissions policy that controls the actions and reusable workflows that are allowed to run.
github: Actions_variables_body
Fields
- name string - The name of the variable.
- value string - The value of the variable.
- visibility "all"|"private"|"selected" - The type of repositories in the organization that can access the variable.
selected
means only the repositories specified byselected_repository_ids
can access the variable.
- selected_repository_ids int[]? - An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the
visibility
is set toselected
.
github: Actions_variables_body_1
Fields
- name string - The name of the variable.
- value string - The value of the variable.
github: ActionsBillingUsage
Fields
- total_minutes_used int - The sum of the free and paid GitHub Actions minutes used.
- total_paid_minutes_used int - The total paid GitHub Actions minutes used.
- included_minutes int - The amount of free GitHub Actions minutes available.
- minutes_used_breakdown Actionsbillingusage_minutes_used_breakdown -
github: Actionsbillingusage_minutes_used_breakdown
Fields
- UBUNTU int? - Total minutes used on Ubuntu runner machines.
- MACOS int? - Total minutes used on macOS runner machines.
- WINDOWS int? - Total minutes used on Windows runner machines.
- ubuntu_4_core int? - Total minutes used on Ubuntu 4 core runner machines.
- ubuntu_8_core int? - Total minutes used on Ubuntu 8 core runner machines.
- ubuntu_16_core int? - Total minutes used on Ubuntu 16 core runner machines.
- ubuntu_32_core int? - Total minutes used on Ubuntu 32 core runner machines.
- ubuntu_64_core int? - Total minutes used on Ubuntu 64 core runner machines.
- windows_4_core int? - Total minutes used on Windows 4 core runner machines.
- windows_8_core int? - Total minutes used on Windows 8 core runner machines.
- windows_16_core int? - Total minutes used on Windows 16 core runner machines.
- windows_32_core int? - Total minutes used on Windows 32 core runner machines.
- windows_64_core int? - Total minutes used on Windows 64 core runner machines.
- macos_12_core int? - Total minutes used on macOS 12 core runner machines.
- total int? - Total minutes used on all runner machines.
github: ActionsCacheList
Repository actions caches
Fields
- total_count int - Total number of caches
- actions_caches Actionscachelist_actions_caches[] - Array of caches
github: Actionscachelist_actions_caches
Fields
- id int? -
- ref string? -
- 'key string? -
- version string? -
- last_accessed_at string? -
- created_at string? -
- size_in_bytes int? -
github: ActionsCacheUsageByRepository
GitHub Actions Cache Usage by repository.
Fields
- full_name string - The repository owner and name for the cache usage being shown.
- active_caches_size_in_bytes int - The sum of the size in bytes of all the active cache items in the repository.
- active_caches_count int - The number of active caches in the repository.
github: ActionsCacheUsageByRepositoryResponse
GitHub Actions Cache Usage by repository.
Fields
- total_count int -
- repository_cache_usages ActionsCacheUsageByRepository[] -
github: ActionsCacheUsageOrgEnterprise
Fields
- total_active_caches_count int - The count of active caches across all repositories of an enterprise or an organization.
- total_active_caches_size_in_bytes int - The total size in bytes of all active cache items across all repositories of an enterprise or an organization.
github: ActionsGetDefaultWorkflowPermissions
Fields
- default_workflow_permissions ActionsDefaultWorkflowPermissions - The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
- can_approve_pull_request_reviews ActionsCanApprovePullRequestReviews - Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
github: ActionsOidcSubjectCustomizationForARepository
Actions OIDC subject customization for a repository
Fields
- use_default boolean - Whether to use the default template or not. If
true
, theinclude_claim_keys
field is ignored.
- include_claim_keys string[]? - Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
github: ActionsOrganizationPermissions
Fields
- enabled_repositories EnabledRepositories - The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
- selected_repositories_url string? - The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when
enabled_repositories
is set toselected
.
- allowed_actions AllowedActions? - The permissions policy that controls the actions and reusable workflows that are allowed to run.
- selected_actions_url SelectedActionsUrl? - The API URL to use to get or set the actions and reusable workflows that are allowed to run, when
allowed_actions
is set toselected
.
github: ActionsPublicKey
The public key used for setting Actions Secrets.
Fields
- key_id string - The identifier for the key.
- 'key string - The Base64 encoded public key.
- id int? -
- url string? -
- title string? -
- created_at string? -
github: ActionsRepositoryPermissions
Fields
- enabled ActionsEnabled - Whether GitHub Actions is enabled on the repository.
- allowed_actions AllowedActions? - The permissions policy that controls the actions and reusable workflows that are allowed to run.
- selected_actions_url SelectedActionsUrl? - The API URL to use to get or set the actions and reusable workflows that are allowed to run, when
allowed_actions
is set toselected
.
github: ActionsSecret
Set secrets for GitHub Actions.
Fields
- name string - The name of the secret.
- created_at string -
- updated_at string -
github: ActionsSecretResponse
Set secrets for GitHub Actions.
Fields
- total_count int -
- secrets ActionsSecret[] -
github: ActionsSetDefaultWorkflowPermissions
Fields
- default_workflow_permissions ActionsDefaultWorkflowPermissions? - The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
- can_approve_pull_request_reviews ActionsCanApprovePullRequestReviews? - Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
github: ActionsVariable
Fields
- name string - The name of the variable.
- value string - The value of the variable.
- created_at string - The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- updated_at string - The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
github: ActionsVariableResponse
Fields
- total_count int -
- variables ActionsVariable[] -
github: ActionsWorkflowAccessToRepository
Fields
- access_level "none"|"user"|"organization" - Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the
repository.
none
means the access is only possible from workflows in this repository.user
level access allows sharing across user owned private repos only.organization
level access allows sharing across the organization.
github: Activity
Activity
Fields
- id int -
- node_id string -
- before string - The SHA of the commit before the activity.
- after string - The SHA of the commit after the activity.
- ref string - The full Git reference, formatted as
refs/heads/<branch name>
.
- timestamp string - The time when the activity occurred.
- activity_type "push"|"force_push"|"branch_deletion"|"branch_creation"|"pr_merge"|"merge_queue_merge" - The type of the activity that was performed.
- actor NullableSimpleUser - A GitHub user.
github: Actor
Actor
Fields
- id int -
- login string -
- display_login string? -
- gravatar_id string -
- url string -
- avatar_url string -
github: AddedToProjectIssueEvent
Added to Project Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- project_card Addedtoprojectissueevent_project_card? -
github: Addedtoprojectissueevent_project_card
Fields
- id int -
- url string -
- project_id int -
- project_url string -
- column_name string -
- previous_column_name string? -
github: Alerts_alert_number_body
Fields
- state CodeScanningAlertSetState - Sets the state of the code scanning alert. You must provide
dismissed_reason
when you set the state todismissed
.
- dismissed_reason CodeScanningAlertDismissedReason? - Required when the state is dismissed. The reason for dismissing or closing the alert.
- dismissed_comment CodeScanningAlertDismissedComment? - The dismissal comment associated with the dismissal of the alert.
github: Alerts_alert_number_body_1
Fields
- state "dismissed"|"open" - The state of the Dependabot alert.
A
dismissed_reason
must be provided when setting the state todismissed
.
- dismissed_reason "fix_started"|"inaccurate"|"no_bandwidth"|"not_used"|"tolerable_risk" ? - Required when
state
isdismissed
. A reason for dismissing the alert.
- dismissed_comment string? - An optional comment associated with dismissing the alert.
github: Alerts_alert_number_body_2
Fields
- state SecretScanningAlertState - Sets the state of the secret scanning alert. You must provide
resolution
when you set the state toresolved
.
- resolution SecretScanningAlertResolution? - Required when the
state
isresolved
. The reason for resolving the alert.
- resolution_comment SecretScanningAlertResolutionComment? - An optional comment when closing an alert. Cannot be updated or deleted. Must be
null
when changingstate
toopen
.
github: ApiOverview
Api Overview
Fields
- verifiable_password_authentication boolean -
- ssh_key_fingerprints Apioverview_ssh_key_fingerprints? -
- ssh_keys string[]? -
- hooks string[]? -
- github_enterprise_importer string[]? -
- web string[]? -
- api string[]? -
- git string[]? -
- packages string[]? -
- pages string[]? -
- importer string[]? -
- actions string[]? -
- dependabot string[]? -
- domains Apioverview_domains? -
github: Apioverview_domains
Fields
- website string[]? -
- codespaces string[]? -
- copilot string[]? -
- packages string[]? -
github: Apioverview_ssh_key_fingerprints
Fields
- SHA256_RSA string? -
- SHA256_DSA string? -
- SHA256_ECDSA string? -
- SHA256_ED25519 string? -
github: AppPermissions
The permissions granted to the user access token.
Fields
- actions "read"|"write" ? - The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.
- administration "read"|"write" ? - The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.
- checks "read"|"write" ? - The level of permission to grant the access token for checks on code.
- contents "read"|"write" ? - The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
- deployments "read"|"write" ? - The level of permission to grant the access token for deployments and deployment statuses.
- environments "read"|"write" ? - The level of permission to grant the access token for managing repository environments.
- issues "read"|"write" ? - The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.
- metadata "read"|"write" ? - The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.
- packages "read"|"write" ? - The level of permission to grant the access token for packages published to GitHub Packages.
- pages "read"|"write" ? - The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.
- pull_requests "read"|"write" ? - The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.
- repository_hooks "read"|"write" ? - The level of permission to grant the access token to manage the post-receive hooks for a repository.
- repository_projects "read"|"write"|"admin" ? - The level of permission to grant the access token to manage repository projects, columns, and cards.
- secret_scanning_alerts "read"|"write" ? - The level of permission to grant the access token to view and manage secret scanning alerts.
- secrets "read"|"write" ? - The level of permission to grant the access token to manage repository secrets.
- security_events "read"|"write" ? - The level of permission to grant the access token to view and manage security events like code scanning alerts.
- single_file "read"|"write" ? - The level of permission to grant the access token to manage just a single file.
- statuses "read"|"write" ? - The level of permission to grant the access token for commit statuses.
- vulnerability_alerts "read"|"write" ? - The level of permission to grant the access token to manage Dependabot alerts.
- workflows "write" ? - The level of permission to grant the access token to update GitHub Actions workflow files.
- members "read"|"write" ? - The level of permission to grant the access token for organization teams and members.
- organization_administration "read"|"write" ? - The level of permission to grant the access token to manage access to an organization.
- organization_custom_roles "read"|"write" ? - The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.
- organization_announcement_banners "read"|"write" ? - The level of permission to grant the access token to view and manage announcement banners for an organization.
- organization_hooks "read"|"write" ? - The level of permission to grant the access token to manage the post-receive hooks for an organization.
- organization_personal_access_tokens "read"|"write" ? - The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.
- organization_personal_access_token_requests "read"|"write" ? - The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.
- organization_plan "read" ? - The level of permission to grant the access token for viewing an organization's plan.
- organization_projects "read"|"write"|"admin" ? - The level of permission to grant the access token to manage organization projects and projects beta (where available).
- organization_packages "read"|"write" ? - The level of permission to grant the access token for organization packages published to GitHub Packages.
- organization_secrets "read"|"write" ? - The level of permission to grant the access token to manage organization secrets.
- organization_self_hosted_runners "read"|"write" ? - The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.
- organization_user_blocking "read"|"write" ? - The level of permission to grant the access token to view and manage users blocked by the organization.
- team_discussions "read"|"write" ? - The level of permission to grant the access token to manage team discussions and related comments.
github: Artifact
An artifact
Fields
- id int -
- node_id string -
- name string - The name of the artifact.
- size_in_bytes int - The size in bytes of the artifact.
- url string -
- archive_download_url string -
- expired boolean - Whether or not the artifact has expired.
- created_at string -
- expires_at string -
- updated_at string -
- workflow_run Artifact_workflow_run? -
github: Artifact_workflow_run
Fields
- id int? -
- repository_id int? -
- head_repository_id int? -
- head_branch string? -
- head_sha string? -
github: ArtifactResponse
An artifact
Fields
- total_count int -
- artifacts Artifact[] -
github: Assets_asset_id_body
Fields
- name string? - The file name of the asset.
- label string? - An alternate short description of the asset. Used in place of the filename.
- state string? -
github: AssignedIssueEvent
Assigned Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app Integration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- assignee SimpleUser - A GitHub user.
- assigner SimpleUser - A GitHub user.
github: AuthenticationToken
Authentication Token
Fields
- token string - The token used for authentication
- expires_at string - The time this token expires
- permissions record {}? -
- repositories Repository[]? - The repositories this token has access to
- single_file string? -
- repository_selection "all"|"selected" ? - Describe whether all repositories have been selected or there's a selection involved
github: Authorization
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
Fields
- id int -
- url string -
- scopes string[] - A list of scopes that this authorization is in.
- token string -
- token_last_eight string -
- hashed_token string -
- app Authorization_app -
- note string -
- note_url string -
- updated_at string -
- created_at string -
- fingerprint string -
- user NullableSimpleUser? - A GitHub user.
- installation NullableScopedInstallation? -
- expires_at string -
github: Authorization_app
Fields
- client_id string -
- name string -
- url string -
github: Authors_author_id_body
Fields
- email string? - The new Git author email.
- name string? - The new Git author name.
github: Autolink
An autolink reference.
Fields
- id int -
- key_prefix string - The prefix of a key that is linkified.
- url_template string - A template for the target URL that is generated if a key was found.
- is_alphanumeric boolean - Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.
github: AutoMerge
The status of auto merging a pull request.
Fields
- enabled_by SimpleUser - A GitHub user.
- merge_method "merge"|"squash"|"rebase" - The merge method to use.
- commit_title string - Title for the merge commit message.
- commit_message string - Commit message for the merge commit.
github: BaseGist
Base Gist
Fields
- url string -
- forks_url string -
- commits_url string -
- id string -
- node_id string -
- git_pull_url string -
- git_push_url string -
- html_url string -
- files record { Basegist_files... } -
- 'public boolean -
- created_at string -
- updated_at string -
- description string -
- comments int -
- user NullableSimpleUser - A GitHub user.
- comments_url string -
- owner SimpleUser? - A GitHub user.
- truncated boolean? -
- forks anydata[]? -
- history anydata[]? -
github: Basegist_files
Fields
- filename string? -
- 'type string? -
- language string? -
- raw_url string? -
- size int? -
github: BasicError
Basic Error
Fields
- message string? -
- documentation_url string? -
- url string? -
- status string? -
github: Billing_selected_teams_body
Fields
- selected_teams string[] - List of team names within the organization to which to grant access to GitHub Copilot.
github: Billing_selected_teams_body_1
Fields
- selected_teams string[] - The names of teams from which to revoke access to GitHub Copilot.
github: Billing_selected_users_body
Fields
- selected_usernames string[] - The usernames of the organization members to be granted access to GitHub Copilot.
github: Billing_selected_users_body_1
Fields
- selected_usernames string[] - The usernames of the organization members for which to revoke access to GitHub Copilot.
github: Blob
Blob
Fields
- content string -
- encoding string -
- url string -
- sha string -
- size int -
- node_id string -
- highlighted_content string? -
github: Branch_protection_body
Fields
- required_status_checks Reposownerrepobranchesbranchprotection_required_status_checks - Require status checks to pass before merging. Set to
null
to disable.
- enforce_admins boolean - Enforce all configured restrictions for administrators. Set to
true
to enforce required status checks for repository administrators. Set tonull
to disable.
- required_pull_request_reviews Reposownerrepobranchesbranchprotection_required_pull_request_reviews - Require at least one approving review on a pull request, before merging. Set to
null
to disable.
- restrictions Reposownerrepobranchesbranchprotection_restrictions - Restrict who can push to the protected branch. User, app, and team
restrictions
are only available for organization-owned repositories. Set tonull
to disable.
- required_linear_history boolean? - Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to
true
to enforce a linear commit history. Set tofalse
to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default:false
. For more information, see "Requiring a linear commit history" in the GitHub Help documentation.
- allow_force_pushes boolean? - Permits force pushes to the protected branch by anyone with write access to the repository. Set to
true
to allow force pushes. Set tofalse
ornull
to block force pushes. Default:false
. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation."
- allow_deletions boolean? - Allows deletion of the protected branch by anyone with write access to the repository. Set to
false
to prevent deletion of the protected branch. Default:false
. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation.
- block_creations boolean? - If set to
true
, therestrictions
branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set totrue
to restrict new branch creation. Default:false
.
- required_conversation_resolution boolean? - Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to
false
to disable. Default:false
.
- lock_branch boolean(default false) - Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default:
false
.
- allow_fork_syncing boolean(default false) - Whether users can pull changes from upstream when the branch is locked. Set to
true
to allow fork syncing. Set tofalse
to prevent fork syncing. Default:false
.
github: Branch_rename_body
Fields
- new_name string - The new name of the branch.
github: BranchProtection
Branch Protection
Fields
- url string? -
- enabled boolean? -
- required_status_checks ProtectedBranchRequiredStatusCheck? - Protected Branch Required Status Check
- enforce_admins ProtectedBranchAdminEnforced? - Protected Branch Admin Enforced
- required_pull_request_reviews ProtectedBranchPullRequestReview? - Protected Branch Pull Request Review
- restrictions BranchRestrictionPolicy? - Branch Restriction Policy
- required_linear_history Branchprotection_required_linear_history? -
- allow_force_pushes Branchprotection_required_linear_history? -
- allow_deletions Branchprotection_required_linear_history? -
- block_creations Branchprotection_required_linear_history? -
- required_conversation_resolution Branchprotection_required_linear_history? -
- name string? -
- protection_url string? -
- required_signatures Branchprotection_required_signatures? -
- lock_branch Branchprotection_lock_branch? - Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
- allow_fork_syncing Branchprotection_allow_fork_syncing? - Whether users can pull changes from upstream when the branch is locked. Set to
true
to allow fork syncing. Set tofalse
to prevent fork syncing.
github: Branchprotection_allow_fork_syncing
Whether users can pull changes from upstream when the branch is locked. Set to true
to allow fork syncing. Set to false
to prevent fork syncing.
Fields
- enabled boolean? -
github: Branchprotection_lock_branch
Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
Fields
- enabled boolean? -
github: Branchprotection_required_linear_history
Fields
- enabled boolean? -
github: Branchprotection_required_signatures
Fields
- url string -
- enabled boolean -
github: BranchRestrictionPolicy
Branch Restriction Policy
Fields
- url string -
- users_url string -
- teams_url string -
- apps_url string -
- users Repository_template_repository_owner[] -
- teams Branchrestrictionpolicy_teams[] -
- apps Branchrestrictionpolicy_apps[] -
github: Branchrestrictionpolicy_apps
Fields
- id int? -
- slug string? -
- node_id string? -
- owner Branchrestrictionpolicy_owner? -
- name string? -
- description string? -
- external_url string? -
- html_url string? -
- created_at string? -
- updated_at string? -
- permissions Branchrestrictionpolicy_permissions? -
- events string[]? -
github: Branchrestrictionpolicy_owner
Fields
- login string? -
- id int? -
- node_id string? -
- url string? -
- repos_url string? -
- events_url string? -
- hooks_url string? -
- issues_url string? -
- members_url string? -
- public_members_url string? -
- avatar_url string? -
- description string? -
- gravatar_id string? -
- html_url string? -
- followers_url string? -
- following_url string? -
- gists_url string? -
- starred_url string? -
- subscriptions_url string? -
- organizations_url string? -
- received_events_url string? -
- 'type string? -
- site_admin boolean? -
github: Branchrestrictionpolicy_permissions
Fields
- metadata string? -
- contents string? -
- issues string? -
- single_file string? -
github: Branchrestrictionpolicy_teams
Fields
- id int? -
- node_id string? -
- url string? -
- html_url string? -
- name string? -
- slug string? -
- description string? -
- privacy string? -
- notification_setting string? -
- permission string? -
- members_url string? -
- repositories_url string? -
- parent string? -
github: BranchShort
Branch Short
Fields
- name string -
- 'commit Branchshort_commit -
- protected boolean -
github: Branchshort_commit
Fields
- sha string -
- url string -
github: BranchWithProtection
Branch With Protection
Fields
- name string -
- 'commit Commit - Commit
- _links Branchwithprotection__links -
- protected boolean -
- protection BranchProtection - Branch Protection
- protection_url string -
- pattern string? -
- required_approving_review_count int? -
github: Branchwithprotection__links
Fields
- html string -
- self string -
github: Card_id_moves_body
Fields
- position string - The position of the card in a column. Can be one of:
top
,bottom
, orafter:<card_id>
to place after the specified card.
- column_id int? - The unique identifier of the column the card should be moved to
github: Cards_card_id_body
Fields
- note string? - The project card's note
- archived boolean? - Whether or not the card is archived
github: CheckAnnotation
Check Annotation
Fields
- path string -
- start_line int -
- end_line int -
- start_column int -
- end_column int -
- annotation_level string -
- title string -
- message string -
- raw_details string -
- blob_href string -
github: CheckAutomatedSecurityFixes
Check Automated Security Fixes
Fields
- enabled boolean - Whether automated security fixes are enabled for the repository.
- paused boolean - Whether automated security fixes are paused for the repository.
github: CheckRun
A check performed on the code of a given code change
Fields
- id int - The id of the check.
- head_sha string - The SHA of the commit that is being checked.
- node_id string -
- external_id string -
- url string -
- html_url string -
- details_url string -
- status "queued"|"in_progress"|"completed" - The phase of the lifecycle that the check is currently in.
- conclusion "success"|"failure"|"neutral"|"cancelled"|"skipped"|"timed_out"|"action_required" -
- started_at string -
- completed_at string -
- output Checkrun_output -
- name string - The name of the check.
- check_suite Checkrun_check_suite -
- app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- pull_requests PullRequestMinimal[] - Pull requests that are open with a
head_sha
orhead_branch
that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.
- deployment DeploymentSimple? - A deployment created as the result of an Actions check run from a workflow that references an environment
github: Checkrun_check_suite
Fields
- id int -
github: Checkrun_output
Fields
- title string -
- summary string -
- text string -
- annotations_count int -
- annotations_url string -
github: CheckRunResponse
A check performed on the code of a given code change
Fields
- total_count int -
- check_runs CheckRun[] -
github: CheckSuite
A suite of checks performed on the code of a given code change
Fields
- id int -
- node_id string -
- head_branch string -
- head_sha string - The SHA of the head commit that is being checked.
- status "queued"|"in_progress"|"completed" -
- conclusion "success"|"failure"|"neutral"|"cancelled"|"skipped"|"timed_out"|"action_required"|"startup_failure"|"stale"? -
- url string -
- before string -
- after string -
- pull_requests PullRequestMinimal[] -
- app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- repository MinimalRepository - Minimal Repository
- created_at string -
- updated_at string -
- head_commit SimpleCommit - A commit.
- latest_check_runs_count int -
- check_runs_url string -
- rerequestable boolean? -
- runs_rerequestable boolean? -
github: CheckSuitePreference
Check suite configuration preferences for a repository.
Fields
- preferences Checksuitepreference_preferences -
- repository MinimalRepository - Minimal Repository
github: Checksuitepreference_preferences
Fields
- auto_trigger_checks Checksuitepreference_preferences_auto_trigger_checks[]? -
github: Checksuitepreference_preferences_auto_trigger_checks
Fields
- app_id int -
- setting boolean -
github: CheckSuiteResponse
A suite of checks performed on the code of a given code change
Fields
- total_count int -
- check_suites CheckSuite[] -
github: Checksuites_preferences_body
Fields
- auto_trigger_checks Reposownerrepochecksuitespreferences_auto_trigger_checks[]? - Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.
github: Classroom
A GitHub Classroom classroom
Fields
- id int - Unique identifier of the classroom.
- name string - The name of the classroom.
- archived boolean - Whether classroom is archived.
- organization SimpleClassroomOrganization - A GitHub organization.
- url string - The URL of the classroom on GitHub Classroom.
github: ClassroomAcceptedAssignment
A GitHub Classroom accepted assignment
Fields
- id int - Unique identifier of the repository.
- submitted boolean - Whether an accepted assignment has been submitted.
- passing boolean - Whether a submission passed.
- commit_count int - Count of student commits.
- grade string - Most recent grade.
- students SimpleClassroomUser[] -
- repository SimpleClassroomRepository - A GitHub repository view for Classroom
- assignment SimpleClassroomAssignment - A GitHub Classroom assignment
github: ClassroomAssignment
A GitHub Classroom assignment
Fields
- id int - Unique identifier of the repository.
- public_repo boolean - Whether an accepted assignment creates a public repository.
- title string - Assignment title.
- 'type "individual"|"group" - Whether it's a group assignment or individual assignment.
- invite_link string - The link that a student can use to accept the assignment.
- invitations_enabled boolean - Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.
- slug string - Sluggified name of the assignment.
- students_are_repo_admins boolean - Whether students are admins on created repository when a student accepts the assignment.
- feedback_pull_requests_enabled boolean - Whether feedback pull request will be created when a student accepts the assignment.
- max_teams int - The maximum allowable teams for the assignment.
- max_members int - The maximum allowable members per team.
- editor string - The selected editor for the assignment.
- accepted int - The number of students that have accepted the assignment.
- submitted int - The number of students that have submitted the assignment.
- passing int - The number of students that have passed the assignment.
- language string - The programming language used in the assignment.
- deadline string - The time at which the assignment is due.
- starter_code_repository SimpleClassroomRepository - A GitHub repository view for Classroom
- classroom Classroom - A GitHub Classroom classroom
github: ClassroomAssignmentGrade
Grade for a student or groups GitHub Classroom assignment
Fields
- assignment_name string - Name of the assignment
- assignment_url string - URL of the assignment
- starter_code_url string - URL of the starter code for the assignment
- github_username string - GitHub username of the student
- roster_identifier string - Roster identifier of the student
- student_repository_name string - Name of the student's assignment repository
- student_repository_url string - URL of the student's assignment repository
- submission_timestamp string - Timestamp of the student's assignment submission
- points_awarded int - Number of points awarded to the student
- points_available int - Number of points available for the assignment
- group_name string? - If a group assignment, name of the group the student is in
github: Client_id_grant_body
Fields
- access_token string - The OAuth access token used to authenticate to the GitHub API.
github: Client_id_token_body
Fields
- access_token string - The access_token of the OAuth or GitHub application.
github: Client_id_token_body_1
Fields
- access_token string - The OAuth access token used to authenticate to the GitHub API.
github: Client_id_token_body_2
Fields
- access_token string - The access_token of the OAuth or GitHub application.
github: ClientHttp1Settings
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
github: CloneTraffic
Clone Traffic
Fields
- count int -
- uniques int -
- clones Traffic[] -
github: CodeOfConduct
Code Of Conduct
Fields
- 'key string -
- name string -
- url string -
- body string? -
- html_url string -
github: CodeOfConductSimple
Code of Conduct Simple
Fields
- url string -
- 'key string -
- name string -
- html_url string -
github: CodeownersErrors
A list of errors found in a repo's CODEOWNERS file
Fields
- errors Codeownerserrors_errors[] -
github: Codeownerserrors_errors
Fields
- line int - The line number where this errors occurs.
- column int - The column number where this errors occurs.
- 'source string? - The contents of the line where the error occurs.
- kind string - The type of error.
- suggestion string? - Suggested action to fix the error. This will usually be
null
, but is provided for some common errors.
- message string - A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).
- path string - The path of the file where the error occured.
github: Codescanning_sarifs_body
Fields
- commit_sha CodeScanningAnalysisCommitSha - The SHA of the commit to which the analysis you are uploading relates.
- ref CodeScanningRef - The full Git reference, formatted as
refs/heads/<branch name>
,refs/pull/<number>/merge
, orrefs/pull/<number>/head
.
- sarif CodeScanningAnalysisSarifFile - A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using
gzip
and then translate the contents of the file into a Base64 encoding string. For more information, see "SARIF support for code scanning."
- checkout_uri string? - The base directory used in the analysis, as it appears in the SARIF file. This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.
- tool_name string? - The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the
tool_guid
parameter of operations such asGET /repos/{owner}/{repo}/code-scanning/alerts
.
- validate boolean? - Whether the SARIF file will be validated according to the code scanning specifications. This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
github: CodeScanningAlert
Fields
- number AlertNumber - The security alert number.
- created_at AlertCreatedAt - The time that the alert was created in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- updated_at AlertUpdatedAt? - The time that the alert was last updated in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- url AlertUrl - The REST API URL of the alert resource.
- html_url AlertHtmlUrl - The GitHub URL of the alert resource.
- instances_url AlertInstancesUrl - The REST API URL for fetching the list of instances for an alert.
- state CodeScanningAlertState - State of a code scanning alert.
- fixed_at AlertFixedAt? - The time that the alert was no longer detected and was considered fixed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- dismissed_by NullableSimpleUser - A GitHub user.
- dismissed_at AlertDismissedAt - The time that the alert was dismissed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- dismissed_reason CodeScanningAlertDismissedReason - Required when the state is dismissed. The reason for dismissing or closing the alert.
- dismissed_comment CodeScanningAlertDismissedComment? - The dismissal comment associated with the dismissal of the alert.
- rule CodeScanningAlertRule -
- tool CodeScanningAnalysisTool -
- most_recent_instance CodeScanningAlertInstance -
github: CodeScanningAlertInstance
Fields
- ref CodeScanningRef? - The full Git reference, formatted as
refs/heads/<branch name>
,refs/pull/<number>/merge
, orrefs/pull/<number>/head
.
- analysis_key CodeScanningAnalysisAnalysisKey? - Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
- environment CodeScanningAlertEnvironment? - Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
- category CodeScanningAnalysisCategory? - Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.
- state CodeScanningAlertState? - State of a code scanning alert.
- commit_sha string? -
- message Codescanningalertinstance_message? -
- location CodeScanningAlertLocation? - Describe a region within a file for the alert.
- html_url string? -
- classifications CodeScanningAlertClassification[]? - Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file.
github: Codescanningalertinstance_message
Fields
- text string? -
github: CodeScanningAlertItems
Fields
- number AlertNumber - The security alert number.
- created_at AlertCreatedAt - The time that the alert was created in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- updated_at AlertUpdatedAt? - The time that the alert was last updated in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- url AlertUrl - The REST API URL of the alert resource.
- html_url AlertHtmlUrl - The GitHub URL of the alert resource.
- instances_url AlertInstancesUrl - The REST API URL for fetching the list of instances for an alert.
- state CodeScanningAlertState - State of a code scanning alert.
- fixed_at AlertFixedAt? - The time that the alert was no longer detected and was considered fixed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- dismissed_by NullableSimpleUser - A GitHub user.
- dismissed_at AlertDismissedAt - The time that the alert was dismissed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- dismissed_reason CodeScanningAlertDismissedReason - Required when the state is dismissed. The reason for dismissing or closing the alert.
- dismissed_comment CodeScanningAlertDismissedComment? - The dismissal comment associated with the dismissal of the alert.
- rule CodeScanningAlertRuleSummary -
- tool CodeScanningAnalysisTool -
- most_recent_instance CodeScanningAlertInstance -
github: CodeScanningAlertLocation
Describe a region within a file for the alert.
Fields
- path string? -
- start_line int? -
- end_line int? -
- start_column int? -
- end_column int? -
github: CodeScanningAlertRule
Fields
- id string? - A unique identifier for the rule used to detect the alert.
- name string? - The name of the rule used to detect the alert.
- severity "none"|"note"|"warning"|"error" ? - The severity of the alert.
- security_severity_level "low"|"medium"|"high"|"critical" ? - The security severity of the alert.
- description string? - A short description of the rule used to detect the alert.
- full_description string? - description of the rule used to detect the alert.
- tags string[]? - A set of tags applicable for the rule.
- help string? - Detailed documentation for the rule as GitHub Flavored Markdown.
- help_uri string? - A link to the documentation for the rule used to detect the alert.
github: CodeScanningAlertRuleSummary
Fields
- id string? - A unique identifier for the rule used to detect the alert.
- name string? - The name of the rule used to detect the alert.
- tags string[]? - A set of tags applicable for the rule.
- severity "none"|"note"|"warning"|"error" ? - The severity of the alert.
- description string? - A short description of the rule used to detect the alert.
github: CodeScanningAnalysis
Fields
- ref CodeScanningRef - The full Git reference, formatted as
refs/heads/<branch name>
,refs/pull/<number>/merge
, orrefs/pull/<number>/head
.
- commit_sha CodeScanningAnalysisCommitSha - The SHA of the commit to which the analysis you are uploading relates.
- analysis_key CodeScanningAnalysisAnalysisKey - Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
- environment CodeScanningAnalysisEnvironment - Identifies the variable values associated with the environment in which this analysis was performed.
- category CodeScanningAnalysisCategory? - Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.
- 'error string -
- created_at CodeScanningAnalysisCreatedAt - The time that the analysis was created in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- results_count int - The total number of results in the analysis.
- rules_count int - The total number of rules used in the analysis.
- id int - Unique identifier for this analysis.
- url CodeScanningAnalysisUrl - The REST API URL of the analysis resource.
- sarif_id CodeScanningAnalysisSarifId - An identifier for the upload.
- tool CodeScanningAnalysisTool -
- deletable boolean -
- warning string - Warning generated when processing the analysis
github: CodeScanningAnalysisDeletion
Successful deletion of a code scanning analysis
Fields
- next_analysis_url string - Next deletable analysis in chain, without last analysis deletion confirmation
- confirm_delete_url string - Next deletable analysis in chain, with last analysis deletion confirmation
github: CodeScanningAnalysisTool
Fields
- name CodeScanningAnalysisToolName? - The name of the tool used to generate the code scanning analysis.
- version CodeScanningAnalysisToolVersion? - The version of the tool used to generate the code scanning analysis.
- guid CodeScanningAnalysisToolGuid? - The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
github: CodeScanningCodeqlDatabase
A CodeQL database.
Fields
- id int - The ID of the CodeQL database.
- name string - The name of the CodeQL database.
- language string - The language of the CodeQL database.
- uploader SimpleUser - A GitHub user.
- content_type string - The MIME type of the CodeQL database file.
- size int - The size of the CodeQL database file in bytes.
- created_at string - The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- updated_at string - The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- url string - The URL at which to download the CodeQL database. The
Accept
header must be set to the value of thecontent_type
property.
- commit_oid string? - The commit SHA of the repository at the time the CodeQL database was created.
github: CodeScanningDefaultSetup
Configuration for code scanning default setup.
Fields
- state "configured"|"not-configured" ? - Code scanning default setup has been configured or not.
- languages ("c-cpp"|"csharp"|"go"|"java-kotlin"|"javascript-typescript"|"javascript"|"python"|"ruby"|"typescript"|"swift")[]? - Languages to be analyzed.
- query_suite "default"|"extended" ? - CodeQL query suite to be used.
- updated_at string? - Timestamp of latest configuration update.
- schedule "weekly" ? - The frequency of the periodic analysis.
github: CodeScanningDefaultSetupUpdate
Configuration for code scanning default setup.
Fields
- state "configured"|"not-configured" - Whether code scanning default setup has been configured or not.
- query_suite "default"|"extended" ? - CodeQL query suite to be used.
- languages ("c-cpp"|"csharp"|"go"|"java-kotlin"|"javascript-typescript"|"python"|"ruby"|"swift")[]? - CodeQL languages to be analyzed.
github: CodeScanningDefaultSetupUpdateResponse
You can use run_url
to track the status of the run. This includes a property status and conclusion.
You should not rely on this always being an actions workflow run object.
Fields
- run_id int? - ID of the corresponding run.
- run_url string? - URL of the corresponding run.
github: CodeScanningOrganizationAlertItems
Fields
- number AlertNumber - The security alert number.
- created_at AlertCreatedAt - The time that the alert was created in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- updated_at AlertUpdatedAt? - The time that the alert was last updated in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- url AlertUrl - The REST API URL of the alert resource.
- html_url AlertHtmlUrl - The GitHub URL of the alert resource.
- instances_url AlertInstancesUrl - The REST API URL for fetching the list of instances for an alert.
- state CodeScanningAlertState - State of a code scanning alert.
- fixed_at AlertFixedAt? - The time that the alert was no longer detected and was considered fixed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- dismissed_by NullableSimpleUser - A GitHub user.
- dismissed_at AlertDismissedAt - The time that the alert was dismissed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- dismissed_reason CodeScanningAlertDismissedReason - Required when the state is dismissed. The reason for dismissing or closing the alert.
- dismissed_comment CodeScanningAlertDismissedComment? - The dismissal comment associated with the dismissal of the alert.
- rule CodeScanningAlertRule -
- tool CodeScanningAnalysisTool -
- most_recent_instance CodeScanningAlertInstance -
- repository SimpleRepository - A GitHub repository.
github: CodeScanningSarifsReceipt
Fields
- id CodeScanningAnalysisSarifId? - An identifier for the upload.
- url string? - The REST API URL for checking the status of the upload.
github: CodeScanningSarifsStatus
Fields
- processing_status "pending"|"complete"|"failed" ? -
pending
files have not yet been processed, whilecomplete
means results from the SARIF have been stored.failed
files have either not been processed at all, or could only be partially processed.
- analyses_url string? - The REST API URL for getting the analyses associated with the upload.
- errors string[]? - Any errors that ocurred during processing of the delivery.
github: CodeSearchResultItem
Code Search Result Item
Fields
- name string -
- path string -
- sha string -
- url string -
- git_url string -
- html_url string -
- repository MinimalRepository - Minimal Repository
- score decimal -
- file_size int? -
- language string? -
- last_modified_at string? -
- line_numbers string[]? -
- text_matches SearchResultTextMatches? -
github: CodeSearchResultItemResponse
Code Search Result Item
Fields
- total_count int -
- incomplete_results boolean -
- items CodeSearchResultItem[] -
github: Codespace
A codespace.
Fields
- id int -
- name string - Automatically generated name of this codespace.
- display_name string? - Display name for this codespace.
- environment_id string - UUID identifying this codespace's environment.
- owner SimpleUser - A GitHub user.
- billable_owner SimpleUser - A GitHub user.
- repository MinimalRepository - Minimal Repository
- machine NullableCodespaceMachine - A description of the machine powering a codespace.
- devcontainer_path string? - Path to devcontainer.json from repo root used to create Codespace.
- prebuild boolean - Whether the codespace was created from a prebuild.
- created_at string -
- updated_at string -
- last_used_at string - Last known time this codespace was started.
- state "Unknown"|"Created"|"Queued"|"Provisioning"|"Available"|"Awaiting"|"Unavailable"|"Deleted"|"Moved"|"Shutdown"|"Archived"|"Starting"|"ShuttingDown"|"Failed"|"Exporting"|"Updating"|"Rebuilding" - State of this codespace.
- url string - API URL for this codespace.
- git_status Codespace_git_status - Details about the codespace's git repository.
- location "EastUs"|"SouthEastAsia"|"WestEurope"|"WestUs2" - The initally assigned location of a new codespace.
- idle_timeout_minutes int - The number of minutes of inactivity after which this codespace will be automatically stopped.
- web_url string - URL to access this codespace on the web.
- machines_url string - API URL to access available alternate machine types for this codespace.
- start_url string - API URL to start this codespace.
- stop_url string - API URL to stop this codespace.
- publish_url string? - API URL to publish this codespace to a new repository.
- pulls_url string - API URL for the Pull Request associated with this codespace, if any.
- recent_folders string[] -
- runtime_constraints Codespace_runtime_constraints? -
- pending_operation boolean? - Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.
- pending_operation_disabled_reason string? - Text to show user when codespace is disabled by a pending operation
- idle_timeout_notice string? - Text to show user when codespace idle timeout minutes has been overriden by an organization policy
- retention_period_minutes int? - Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
- retention_expires_at string? - When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"
- last_known_stop_notice string? - The text to display to a user when a codespace has been stopped for a potentially actionable reason.
github: Codespace_git_status
Details about the codespace's git repository.
Fields
- ahead int? - The number of commits the local repository is ahead of the remote.
- behind int? - The number of commits the local repository is behind the remote.
- has_unpushed_changes boolean? - Whether the local repository has unpushed changes.
- has_uncommitted_changes boolean? - Whether the local repository has uncommitted changes.
- ref string? - The current branch (or SHA if in detached HEAD state) of the local repository.
github: Codespace_name_publish_body
Fields
- name string? - A name for the new repository.
- 'private boolean? - Whether the new repository should be private.
github: Codespace_runtime_constraints
Fields
- allowed_port_privacy_settings string[]? - The privacy settings a user can select from when forwarding a port.
github: CodespaceDefault
Codespace default attributes
Fields
- location string -
- devcontainer_path string -
github: CodespaceDefaultResponse
Codespace default attributes
Fields
- billable_owner SimpleUser? - A GitHub user.
- defaults CodespaceDefault? - Codespace default attributes
github: CodespaceExportDetails
An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest
Fields
- state string? - State of the latest export
- completed_at string? - Completion time of the last export operation
- branch string? - Name of the exported branch
- sha string? - Git commit SHA of the exported branch
- id string? - Id for the export details
- export_url string? - Url for fetching export details
- html_url string? - Web url for the exported branch
github: CodespaceMachine
A description of the machine powering a codespace.
Fields
- name string - The name of the machine.
- display_name string - The display name of the machine includes cores, memory, and storage.
- operating_system string - The operating system of the machine.
- storage_in_bytes int - How much storage is available to the codespace.
- memory_in_bytes int - How much memory is available to the codespace.
- cpus int - How many cores are available to the codespace.
- prebuild_availability "none"|"ready"|"in_progress" - Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status.
github: CodespaceMachineResponse
A description of the machine powering a codespace.
Fields
- total_count int -
- machines CodespaceMachine[] -
github: CodespaceResponse
A codespace.
Fields
- total_count int -
- codespaces Codespace[] -
github: Codespaces_access_body
Fields
- visibility "disabled"|"selected_members"|"all_members"|"all_members_and_outside_collaborators" - Which users can access codespaces in the organization.
disabled
means that no users can access codespaces in the organization.
- selected_usernames string[]? - The usernames of the organization members who should have access to codespaces in the organization. Required when
visibility
isselected_members
. The provided list of usernames will replace any existing value.
github: Codespaces_codespace_name_body
Fields
- machine string? - A valid machine to transition this codespace to.
- display_name string? - Display name for this codespace
- recent_folders string[]? - Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.
github: CodespacesOrgSecret
Secrets for a GitHub Codespace.
Fields
- name string - The name of the secret
- created_at string - The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- updated_at string - The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- visibility "all"|"private"|"selected" - The type of repositories in the organization that the secret is visible to
- selected_repositories_url string? - The API URL at which the list of repositories this secret is visible to can be retrieved
github: CodespacesOrgSecretResponse
Secrets for a GitHub Codespace.
Fields
- total_count int -
- secrets CodespacesOrgSecret[] -
github: CodespacesPermissionsCheckForDevcontainer
Permission check result for a given devcontainer config.
Fields
- accepted boolean - Whether the user has accepted the permissions defined by the devcontainer config
github: CodespacesPublicKey
The public key used for setting Codespaces secrets.
Fields
- key_id string - The identifier for the key.
- 'key string - The Base64 encoded public key.
- id int? -
- url string? -
- title string? -
- created_at string? -
github: CodespacesSecret
Secrets for a GitHub Codespace.
Fields
- name string - The name of the secret
- created_at string - The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- updated_at string - The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- visibility "all"|"private"|"selected" - The type of repositories in the organization that the secret is visible to
- selected_repositories_url string - The API URL at which the list of repositories this secret is visible to can be retrieved
github: CodespacesSecretResponse
Secrets for a GitHub Codespace.
Fields
- total_count int -
- secrets CodespacesSecret[] -
github: CodespacesUserPublicKey
The public key used for setting user Codespaces' Secrets.
Fields
- key_id string - The identifier for the key.
- 'key string - The Base64 encoded public key.
github: CodespaceWithFullRepository
A codespace.
Fields
- id int -
- name string - Automatically generated name of this codespace.
- display_name string? - Display name for this codespace.
- environment_id string - UUID identifying this codespace's environment.
- owner SimpleUser - A GitHub user.
- billable_owner SimpleUser - A GitHub user.
- repository FullRepository - Full Repository
- machine NullableCodespaceMachine - A description of the machine powering a codespace.
- devcontainer_path string? - Path to devcontainer.json from repo root used to create Codespace.
- prebuild boolean - Whether the codespace was created from a prebuild.
- created_at string -
- updated_at string -
- last_used_at string - Last known time this codespace was started.
- state "Unknown"|"Created"|"Queued"|"Provisioning"|"Available"|"Awaiting"|"Unavailable"|"Deleted"|"Moved"|"Shutdown"|"Archived"|"Starting"|"ShuttingDown"|"Failed"|"Exporting"|"Updating"|"Rebuilding" - State of this codespace.
- url string - API URL for this codespace.
- git_status Codespace_git_status - Details about the codespace's git repository.
- location "EastUs"|"SouthEastAsia"|"WestEurope"|"WestUs2" - The initally assigned location of a new codespace.
- idle_timeout_minutes int - The number of minutes of inactivity after which this codespace will be automatically stopped.
- web_url string - URL to access this codespace on the web.
- machines_url string - API URL to access available alternate machine types for this codespace.
- start_url string - API URL to start this codespace.
- stop_url string - API URL to stop this codespace.
- publish_url string? - API URL to publish this codespace to a new repository.
- pulls_url string - API URL for the Pull Request associated with this codespace, if any.
- recent_folders string[] -
- runtime_constraints Codespace_runtime_constraints? -
- pending_operation boolean? - Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.
- pending_operation_disabled_reason string? - Text to show user when codespace is disabled by a pending operation
- idle_timeout_notice string? - Text to show user when codespace idle timeout minutes has been overriden by an organization policy
- retention_period_minutes int? - Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
- retention_expires_at string? - When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"
github: Collaborator
Collaborator
Fields
- login string -
- id int -
- email string? -
- name string? -
- node_id string -
- avatar_url string -
- gravatar_id string -
- url string -
- html_url string -
- followers_url string -
- following_url string -
- gists_url string -
- starred_url string -
- subscriptions_url string -
- organizations_url string -
- repos_url string -
- events_url string -
- received_events_url string -
- 'type string -
- site_admin boolean -
- permissions Collaborator_permissions? -
- role_name string -
github: Collaborator_permissions
Fields
- pull boolean -
- triage boolean? -
- push boolean -
- maintain boolean? -
- admin boolean -
github: Collaborators_username_body
Fields
- permission "read"|"write"|"admin" ? - The permission to grant the collaborator.
github: Collaborators_username_body_1
Fields
- permission string? - The permission to grant the collaborator. Only valid on organization-owned repositories. We accept the following permissions to be set:
pull
,triage
,push
,maintain
,admin
and you can also specify a custom repository role name, if the owning organization has defined any.
github: Column_id_moves_body
Fields
- position string - The position of the column in a project. Can be one of:
first
,last
, orafter:<column_id>
to place after the specified column.
github: Columns_column_id_body
Fields
- name string - Name of the project column
github: CombinedBillingUsage
Fields
- days_left_in_billing_cycle int - Numbers of days left in billing cycle.
- estimated_paid_storage_for_month int - Estimated storage space (GB) used in billing cycle.
- estimated_storage_for_month int - Estimated sum of free and paid storage space (GB) used in billing cycle.
github: CombinedCommitStatus
Combined Commit Status
Fields
- state string -
- statuses SimpleCommitStatus[] -
- sha string -
- total_count int -
- repository MinimalRepository - Minimal Repository
- commit_url string -
- url string -
github: Comment_id_reactions_body
Fields
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes" - The reaction type to add to the commit comment.
github: Comment_id_reactions_body_1
Fields
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes" - The reaction type to add to the issue comment.
github: Comment_id_reactions_body_2
Fields
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes" - The reaction type to add to the pull request review comment.
github: Comment_id_replies_body
Fields
- body string - The text of the review comment.
github: Comment_number_reactions_body
Fields
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes" - The reaction type to add to the team discussion comment.
github: Comment_number_reactions_body_1
Fields
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes" - The reaction type to add to the team discussion comment.
github: Comments_comment_id_body
Fields
- body string - The comment text.
github: Comments_comment_id_body_1
Fields
- body string - The contents of the comment
github: Comments_comment_id_body_2
Fields
- body string - The contents of the comment.
github: Comments_comment_id_body_3
Fields
- body string - The text of the reply to the review comment.
github: Comments_comment_number_body
Fields
- body string - The discussion comment's body text.
github: Comments_comment_number_body_1
Fields
- body string - The discussion comment's body text.
github: Commit
Commit
Fields
- url string -
- sha string -
- node_id string -
- html_url string -
- comments_url string -
- 'commit Commit_commit -
- author NullableSimpleUser - A GitHub user.
- committer NullableSimpleUser - A GitHub user.
- parents Commit_parents[] -
- stats Commit_stats? -
- files DiffEntry[]? -
github: Commit_commit
Fields
- url string -
- author NullableGitUser - Metaproperties for Git author/committer information.
- committer NullableGitUser - Metaproperties for Git author/committer information.
- message string -
- comment_count int -
- tree Commit_commit_tree -
- verification Verification? -
github: Commit_commit_tree
Fields
- sha string -
- url string -
github: Commit_parents
Fields
- sha string -
- url string -
- html_url string? -
github: Commit_sha_comments_body
Fields
- body string - The contents of the comment.
- path string? - Relative path of the file to comment on.
- position int? - Line index in the diff to comment on.
- line int? - Deprecated. Use position parameter instead. Line number in the file to comment on.
github: Commit_stats
Fields
- additions int? -
- deletions int? -
- total int? -
github: CommitActivity
Commit Activity
Fields
- days int[] -
- total int -
- week int -
github: CommitComment
Commit Comment
Fields
- html_url string -
- url string -
- id int -
- node_id string -
- body string -
- path string -
- position int -
- line int -
- commit_id string -
- user NullableSimpleUser - A GitHub user.
- created_at string -
- updated_at string -
- author_association AuthorAssociation - How the author is associated with the repository.
- reactions ReactionRollup? -
github: CommitComparison
Commit Comparison
Fields
- url string -
- html_url string -
- permalink_url string -
- diff_url string -
- patch_url string -
- base_commit Commit - Commit
- merge_base_commit Commit - Commit
- status "diverged"|"ahead"|"behind"|"identical" -
- ahead_by int -
- behind_by int -
- total_commits int -
- commits Commit[] -
- files DiffEntry[]? -
github: CommitSearchResultItem
Commit Search Result Item
Fields
- url string -
- sha string -
- html_url string -
- comments_url string -
- 'commit Commitsearchresultitem_commit -
- author NullableSimpleUser - A GitHub user.
- committer NullableGitUser - Metaproperties for Git author/committer information.
- parents Filecommit_commit_parents[] -
- repository MinimalRepository - Minimal Repository
- score decimal -
- node_id string -
- text_matches SearchResultTextMatches? -
github: Commitsearchresultitem_commit
Fields
- author Commitsearchresultitem_commit_author -
- committer NullableGitUser - Metaproperties for Git author/committer information.
- comment_count int -
- message string -
- tree Shortbranch_commit -
- url string -
- verification Verification? -
github: Commitsearchresultitem_commit_author
Fields
- name string -
- email string -
- date string -
github: CommitSearchResultItemResponse
Commit Search Result Item
Fields
- total_count int -
- incomplete_results boolean -
- items CommitSearchResultItem[] -
github: CommunityProfile
Community Profile
Fields
- health_percentage int -
- description string -
- documentation string -
- files Communityprofile_files -
- updated_at string -
- content_reports_enabled boolean? -
github: Communityprofile_files
Fields
- code_of_conduct NullableCodeOfConductSimple - Code of Conduct Simple
- code_of_conduct_file NullableCommunityHealthFile -
- license NullableLicenseSimple - License Simple
- contributing NullableCommunityHealthFile -
- readme NullableCommunityHealthFile -
- issue_template NullableCommunityHealthFile -
- pull_request_template NullableCommunityHealthFile -
github: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
github: ContainerMetadata
Fields
- tags string[] -
github: Contentdirectory_inner
Fields
- 'type "dir"|"file"|"submodule"|"symlink" -
- size int -
- name string -
- path string -
- content string? -
- sha string -
- url string -
- git_url string -
- html_url string -
- download_url string -
github: ContentFile
Content File
Fields
- 'type "file" -
- encoding string -
- size int -
- name string -
- path string -
- content string -
- sha string -
- url string -
- git_url string -
- html_url string -
- download_url string -
- _links Contenttree__links -
- target string? -
- submodule_git_url string? -
github: Contents_path_body
Fields
- message string - The commit message.
- content string - The new file content, using Base64 encoding.
- sha string? - Required if you are updating a file. The blob SHA of the file being replaced.
- branch string? - The branch name. Default: the repository’s default branch.
- committer Reposownerrepocontentspath_committer? - The person that committed the file. Default: the authenticated user.
- author Reposownerrepocontentspath_author? - The author of the file. Default: The
committer
or the authenticated user if you omitcommitter
.
github: Contents_path_body_1
Fields
- message string - The commit message.
- sha string - The blob SHA of the file being deleted.
- branch string? - The branch name. Default: the repository’s default branch
- committer Reposownerrepocontentspath_committer_1? - object containing information about the committer.
- author Reposownerrepocontentspath_author_1? - object containing information about the author.
github: ContentSubmodule
An object describing a submodule
Fields
- 'type "submodule" -
- submodule_git_url string -
- size int -
- name string -
- path string -
- sha string -
- url string -
- git_url string -
- html_url string -
- download_url string -
- _links Contenttree__links -
github: ContentSymlink
An object describing a symlink
Fields
- 'type "symlink" -
- target string -
- size int -
- name string -
- path string -
- sha string -
- url string -
- git_url string -
- html_url string -
- download_url string -
- _links Contenttree__links -
github: ContentTraffic
Content Traffic
Fields
- path string -
- title string -
- count int -
- uniques int -
github: ContentTree
Content Tree
Fields
- 'type string -
- size int -
- name string -
- path string -
- sha string -
- url string -
- git_url string -
- html_url string -
- download_url string -
- entries Contenttree_entries[]? -
- _links Contenttree__links -
github: Contenttree__links
Fields
- git string -
- html string -
- self string -
github: Contenttree_entries
Fields
- 'type string -
- size int -
- name string -
- path string -
- content string? -
- sha string -
- url string -
- git_url string -
- html_url string -
- download_url string -
- _links Contenttree__links -
github: Contributor
Contributor
Fields
- login string? -
- id int? -
- node_id string? -
- avatar_url string? -
- gravatar_id string? -
- url string? -
- html_url string? -
- followers_url string? -
- following_url string? -
- gists_url string? -
- starred_url string? -
- subscriptions_url string? -
- organizations_url string? -
- repos_url string? -
- events_url string? -
- received_events_url string? -
- 'type string -
- site_admin boolean? -
- contributions int -
- email string? -
- name string? -
github: ContributorActivity
Contributor Activity
Fields
- author NullableSimpleUser - A GitHub user.
- total int -
- weeks Contributoractivity_weeks[] -
github: Contributoractivity_weeks
Fields
- w int? -
- a int? -
- d int? -
- c int? -
github: ConvertedNoteToIssueIssueEvent
Converted Note to Issue Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app Integration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- project_card Addedtoprojectissueevent_project_card? -
github: CopilotOrganizationDetails
Information about the seat breakdown and policies set for an organization with a Copilot for Business subscription.
Fields
- seat_breakdown CopilotSeatBreakdown - The breakdown of Copilot for Business seats for the organization.
- public_code_suggestions "allow"|"block"|"unconfigured"|"unknown" - The organization policy for allowing or disallowing Copilot to make suggestions that match public code.
- copilot_chat "enabled"|"disabled"|"unconfigured" ? - The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.
- seat_management_setting "assign_all"|"assign_selected"|"disabled"|"unconfigured" - The mode of assigning new seats.
github: CopilotSeatBreakdown
The breakdown of Copilot for Business seats for the organization.
Fields
- total int? - The total number of seats being billed for the organization as of the current billing cycle.
- added_this_cycle int? - Seats added during the current billing cycle.
- pending_cancellation int? - The number of seats that are pending cancellation at the end of the current billing cycle.
- pending_invitation int? - The number of seats that have been assigned to users that have not yet accepted an invitation to this organization.
- active_this_cycle int? - The number of seats that have used Copilot during the current billing cycle.
- inactive_this_cycle int? - The number of seats that have not used Copilot during the current billing cycle.
github: CopilotSeatCancelled
The total number of seat assignments cancelled.
Fields
- seats_cancelled int -
github: CopilotSeatCreated
The total number of seat assignments created.
Fields
- seats_created int -
github: CopilotSeatDetails
Information about a Copilot for Business seat assignment for a user, team, or organization.
Fields
- assignee SimpleUser|Team|Organization - The assignee that has been granted access to GitHub Copilot.
- assigning_team Team? - The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.
- pending_cancellation_date string? - The pending cancellation date for the seat, in
YYYY-MM-DD
format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle.
- last_activity_at string? - Timestamp of user's last GitHub Copilot activity, in ISO 8601 format.
- last_activity_editor string? - Last editor that was used by the user for a GitHub Copilot completion.
- created_at string - Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format.
- updated_at string? - Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format.
github: CopilotSeatDetailsResponse
Information about a Copilot for Business seat assignment for a user, team, or organization.
Fields
- total_seats int? - Total number of Copilot For Business seats for the organization currently being billed.
- seats CopilotSeatDetails[]? -
github: CustomDeploymentRuleApp
A GitHub App that is providing a custom deployment protection rule.
Fields
- id int - The unique identifier of the deployment protection rule integration.
- slug string - The slugified name of the deployment protection rule integration.
- integration_url string - The URL for the endpoint to get details about the app.
- node_id string - The node ID for the deployment protection rule integration.
github: CustomDeploymentRuleAppResponse
A GitHub App that is providing a custom deployment protection rule.
Fields
- total_count int? - The total number of custom deployment protection rule integrations available for this environment.
- available_custom_deployment_protection_rule_integrations CustomDeploymentRuleApp[]? -
github: DemilestonedIssueEvent
Demilestoned Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- milestone Milestonedissueevent_milestone -
github: DependabotAlert
A Dependabot alert.
Fields
- number AlertNumber - The security alert number.
- state "auto_dismissed"|"dismissed"|"fixed"|"open" - The state of the Dependabot alert.
- dependency Dependabotalertwithrepository_dependency - Details for the vulnerable dependency.
- security_advisory DependabotAlertSecurityAdvisory - Details for the GitHub Security Advisory.
- security_vulnerability DependabotAlertSecurityVulnerability - Details pertaining to one vulnerable version range for the advisory.
- url AlertUrl - The REST API URL of the alert resource.
- html_url AlertHtmlUrl - The GitHub URL of the alert resource.
- created_at AlertCreatedAt - The time that the alert was created in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- updated_at AlertUpdatedAt - The time that the alert was last updated in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- dismissed_at AlertDismissedAt - The time that the alert was dismissed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- dismissed_by NullableSimpleUser - A GitHub user.
- dismissed_reason "fix_started"|"inaccurate"|"no_bandwidth"|"not_used"|"tolerable_risk" - The reason that the alert was dismissed.
- dismissed_comment string - An optional comment associated with the alert's dismissal.
- fixed_at AlertFixedAt - The time that the alert was no longer detected and was considered fixed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- auto_dismissed_at AlertAutoDismissedAt? - The time that the alert was auto-dismissed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
github: DependabotAlertPackage
Details for the vulnerable package.
Fields
- ecosystem string - The package's language or package management ecosystem.
- name string - The unique package name within its ecosystem.
github: DependabotAlertSecurityAdvisory
Details for the GitHub Security Advisory.
Fields
- ghsa_id string - The unique GitHub Security Advisory ID assigned to the advisory.
- cve_id string - The unique CVE ID assigned to the advisory.
- summary string - A short, plain text summary of the advisory.
- description string - A long-form Markdown-supported description of the advisory.
- vulnerabilities DependabotAlertSecurityVulnerability[] - Vulnerable version range information for the advisory.
- severity "low"|"medium"|"high"|"critical" - The severity of the advisory.
- cvss Dependabotalertsecurityadvisory_cvss - Details for the advisory pertaining to the Common Vulnerability Scoring System.
- cwes Dependabotalertsecurityadvisory_cwes[] - Details for the advisory pertaining to Common Weakness Enumeration.
- identifiers Dependabotalertsecurityadvisory_identifiers[] - Values that identify this advisory among security information sources.
- references Dependabotalertsecurityadvisory_references[] - Links to additional advisory information.
- published_at string - The time that the advisory was published in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- updated_at string - The time that the advisory was last modified in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- withdrawn_at string - The time that the advisory was withdrawn in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
github: Dependabotalertsecurityadvisory_cvss
Details for the advisory pertaining to the Common Vulnerability Scoring System.
Fields
- score decimal - The overall CVSS score of the advisory.
- vector_string string - The full CVSS vector string for the advisory.
github: Dependabotalertsecurityadvisory_cwes
A CWE weakness assigned to the advisory.
Fields
- cwe_id string - The unique CWE ID.
- name string - The short, plain text name of the CWE.
github: Dependabotalertsecurityadvisory_identifiers
An advisory identifier.
Fields
- 'type "CVE"|"GHSA" - The type of advisory identifier.
- value string - The value of the advisory identifer.
github: Dependabotalertsecurityadvisory_references
A link to additional advisory information.
Fields
- url string - The URL of the reference.
github: DependabotAlertSecurityVulnerability
Details pertaining to one vulnerable version range for the advisory.
Fields
- package DependabotAlertPackage - Details for the vulnerable package.
- severity "low"|"medium"|"high"|"critical" - The severity of the vulnerability.
- vulnerable_version_range string - Conditions that identify vulnerable versions of this vulnerability's package.
- first_patched_version Dependabotalertsecurityvulnerability_first_patched_version - Details pertaining to the package version that patches this vulnerability.
github: Dependabotalertsecurityvulnerability_first_patched_version
Details pertaining to the package version that patches this vulnerability.
Fields
- identifier string - The package version that patches this vulnerability.
github: DependabotAlertWithRepository
A Dependabot alert.
Fields
- number AlertNumber - The security alert number.
- state "auto_dismissed"|"dismissed"|"fixed"|"open" - The state of the Dependabot alert.
- dependency Dependabotalertwithrepository_dependency - Details for the vulnerable dependency.
- security_advisory DependabotAlertSecurityAdvisory - Details for the GitHub Security Advisory.
- security_vulnerability DependabotAlertSecurityVulnerability - Details pertaining to one vulnerable version range for the advisory.
- url AlertUrl - The REST API URL of the alert resource.
- html_url AlertHtmlUrl - The GitHub URL of the alert resource.
- created_at AlertCreatedAt - The time that the alert was created in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- updated_at AlertUpdatedAt - The time that the alert was last updated in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- dismissed_at AlertDismissedAt - The time that the alert was dismissed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- dismissed_by NullableSimpleUser - A GitHub user.
- dismissed_reason "fix_started"|"inaccurate"|"no_bandwidth"|"not_used"|"tolerable_risk" - The reason that the alert was dismissed.
- dismissed_comment string - An optional comment associated with the alert's dismissal.
- fixed_at AlertFixedAt - The time that the alert was no longer detected and was considered fixed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- auto_dismissed_at AlertAutoDismissedAt? - The time that the alert was auto-dismissed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- repository SimpleRepository - A GitHub repository.
github: Dependabotalertwithrepository_dependency
Details for the vulnerable dependency.
Fields
- package DependabotAlertPackage? - Details for the vulnerable package.
- manifest_path string? - The full path to the dependency manifest file, relative to the root of the repository.
- scope "development"|"runtime" ? - The execution scope of the vulnerable dependency.
github: DependabotPublicKey
The public key used for setting Dependabot Secrets.
Fields
- key_id string - The identifier for the key.
- 'key string - The Base64 encoded public key.
github: DependabotSecret
Set secrets for Dependabot.
Fields
- name string - The name of the secret.
- created_at string -
- updated_at string -
github: DependabotSecretResponse
Set secrets for Dependabot.
Fields
- total_count int -
- secrets DependabotSecret[] -
github: Dependency
Fields
- package_url string? - Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.
- metadata Metadata? - User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
- relationship "direct"|"indirect" ? - A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.
- scope "runtime"|"development" ? - A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.
- dependencies string[]? - Array of package-url (PURLs) of direct child dependencies.
github: Dependencygraphdiff_inner
Fields
- change_type "added"|"removed" -
- manifest string -
- ecosystem string -
- name string -
- version string -
- package_url string -
- license string -
- source_repository_url string -
- scope "unknown"|"runtime"|"development" - Where the dependency is utilized.
development
means that the dependency is only utilized in the development environment.runtime
means that the dependency is utilized at runtime and in the development environment.
github: DependencyGraphSpdxSbom
A schema for the SPDX JSON format returned by the Dependency Graph.
Fields
- sbom Dependencygraphspdxsbom_sbom -
github: Dependencygraphspdxsbom_sbom
Fields
- SPDXID string - The SPDX identifier for the SPDX document.
- spdxVersion string - The version of the SPDX specification that this document conforms to.
- creationInfo Dependencygraphspdxsbom_sbom_creationInfo -
- name string - The name of the SPDX document.
- dataLicense string - The license under which the SPDX document is licensed.
- documentDescribes string[] - The name of the repository that the SPDX document describes.
- documentNamespace string - The namespace for the SPDX document.
- packages Dependencygraphspdxsbom_sbom_packages[] -
github: Dependencygraphspdxsbom_sbom_creationInfo
Fields
- created string - The date and time the SPDX document was created.
- creators string[] - The tools that were used to generate the SPDX document.
github: Dependencygraphspdxsbom_sbom_externalRefs
Fields
- referenceCategory string - The category of reference to an external resource this reference refers to.
- referenceLocator string - A locator for the particular external resource this reference refers to.
- referenceType string - The category of reference to an external resource this reference refers to.
github: Dependencygraphspdxsbom_sbom_packages
Fields
- SPDXID string? - A unique SPDX identifier for the package.
- name string? - The name of the package.
- versionInfo string? - The version of the package. If the package does not have an exact version specified, a version range is given.
- downloadLocation string? - The location where the package can be downloaded, or NOASSERTION if this has not been determined.
- filesAnalyzed boolean? - Whether the package's file content has been subjected to analysis during the creation of the SPDX document.
- licenseConcluded string? - The license of the package as determined while creating the SPDX document.
- licenseDeclared string? - The license of the package as declared by its author, or NOASSERTION if this information was not available when the SPDX document was created.
- supplier string? - The distribution source of this package, or NOASSERTION if this was not determined.
- externalRefs Dependencygraphspdxsbom_sbom_externalRefs[]? -
github: DeployKey
An SSH key granting access to a single repository.
Fields
- id int -
- 'key string -
- url string -
- title string -
- verified boolean -
- created_at string -
- read_only boolean -
- added_by string? -
- last_used string? -
github: Deployment
A request for a specific ref(branch,sha,tag) to be deployed
Fields
- url string -
- id int - Unique identifier of the deployment
- node_id string -
- sha string -
- ref string - The ref to deploy. This can be a branch, tag, or sha.
- task string - Parameter to specify a task to execute
- payload record {}|string -
- original_environment string? -
- environment string - Name for the target deployment environment.
- description string -
- creator NullableSimpleUser - A GitHub user.
- created_at string -
- updated_at string -
- statuses_url string -
- repository_url string -
- transient_environment boolean? - Specifies if the given environment is will no longer exist at some point in the future. Default: false.
- production_environment boolean? - Specifies if the given environment is one that end-users directly interact with. Default: false.
- performed_via_github_app NullableIntegration? - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
github: Deployment_id_statuses_body
Fields
- state "error"|"failure"|"inactive"|"in_progress"|"queued"|"pending"|"success" - The state of the status. When you set a transient deployment to
inactive
, the deployment will be shown asdestroyed
in GitHub.
- target_url string(default "") - The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the
log_url
parameter, which replacestarget_url
.
- log_url string(default "") - The full URL of the deployment's output. This parameter replaces
target_url
. We will continue to accepttarget_url
to support legacy uses, but we recommend replacingtarget_url
withlog_url
. Settinglog_url
will automatically settarget_url
to the same value. Default:""
- description string(default "") - A short description of the status. The maximum description length is 140 characters.
- environment string? - Name for the target deployment environment, which can be changed when setting a deploy status. For example,
production
,staging
, orqa
. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used.
- environment_url string(default "") - Sets the URL for accessing your environment. Default:
""
- auto_inactive boolean? - Adds a new
inactive
status to all prior non-transient, non-production environment deployments with the same repository andenvironment
name as the created status's deployment. Aninactive
status is only added to deployments that had asuccess
state. Default:true
github: DeploymentBranchPolicy
Details of a deployment branch or tag policy.
Fields
- id int? - The unique identifier of the branch or tag policy.
- node_id string? -
- name string? - The name pattern that branches or tags must match in order to deploy to the environment.
- 'type "branch"|"tag" ? - Whether this rule targets a branch or tag.
github: DeploymentBranchPolicyNamePattern
Fields
- name string - The name pattern that branches must match in order to deploy to the environment.
Wildcard characters will not match
/
. For example, to match branches that begin withrelease/
and contain an additional single slash, userelease/*/*
. For more information about pattern matching syntax, see the Ruby File.fnmatch documentation.
github: DeploymentBranchPolicyNamePatternWithType
Fields
- name string - The name pattern that branches or tags must match in order to deploy to the environment.
Wildcard characters will not match
/
. For example, to match branches that begin withrelease/
and contain an additional single slash, userelease/*/*
. For more information about pattern matching syntax, see the Ruby File.fnmatch documentation.
- 'type "branch"|"tag" ? - Whether this rule targets a branch or tag
github: DeploymentBranchPolicyResponse
Details of a deployment branch or tag policy.
Fields
- total_count int - The number of deployment branch policies for the environment.
- branch_policies DeploymentBranchPolicy[] -
github: DeploymentBranchPolicySettings
The type of deployment branch policy for this environment. To allow all branches to deploy, set to null
.
Fields
- protected_branches boolean - Whether only branches with branch protection rules can deploy to this environment. If
protected_branches
istrue
,custom_branch_policies
must befalse
; ifprotected_branches
isfalse
,custom_branch_policies
must betrue
.
- custom_branch_policies boolean - Whether only branches that match the specified name patterns can deploy to this environment. If
custom_branch_policies
istrue
,protected_branches
must befalse
; ifcustom_branch_policies
isfalse
,protected_branches
must betrue
.
github: DeploymentProtectionRule
Deployment protection rule
Fields
- id int - The unique identifier for the deployment protection rule.
- node_id string - The node ID for the deployment protection rule.
- enabled boolean - Whether the deployment protection rule is enabled for the environment.
- app CustomDeploymentRuleApp - A GitHub App that is providing a custom deployment protection rule.
github: DeploymentProtectionRuleResponse
Deployment protection rule
Fields
- total_count int? - The number of enabled custom deployment protection rules for this environment
- custom_deployment_protection_rules DeploymentProtectionRule[]? -
github: DeploymentSimple
A deployment created as the result of an Actions check run from a workflow that references an environment
Fields
- url string -
- id int - Unique identifier of the deployment
- node_id string -
- task string - Parameter to specify a task to execute
- original_environment string? -
- environment string - Name for the target deployment environment.
- description string -
- created_at string -
- updated_at string -
- statuses_url string -
- repository_url string -
- transient_environment boolean? - Specifies if the given environment is will no longer exist at some point in the future. Default: false.
- production_environment boolean? - Specifies if the given environment is one that end-users directly interact with. Default: false.
- performed_via_github_app NullableIntegration? - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
github: DeploymentStatus
The status of a deployment.
Fields
- url string -
- id int -
- node_id string -
- state "error"|"failure"|"inactive"|"pending"|"success"|"queued"|"in_progress" - The state of the status.
- creator NullableSimpleUser - A GitHub user.
- description string - A short description of the status.
- environment string(default "") - The environment of the deployment that the status is for.
- target_url string - Deprecated: the URL to associate with this status.
- created_at string -
- updated_at string -
- deployment_url string -
- repository_url string -
- environment_url string(default "") - The URL for accessing your environment.
- log_url string(default "") - The URL to associate with this status.
- performed_via_github_app NullableIntegration? - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
github: Devcontainers
Dev Containers
Fields
- path string -
- name string? -
- display_name string? -
github: DevcontainersResponse
Dev Containers
Fields
- total_count int -
- devcontainers Devcontainers[] -
github: DiffEntry
Diff Entry
Fields
- sha string -
- filename string -
- status "added"|"removed"|"modified"|"renamed"|"copied"|"changed"|"unchanged" -
- additions int -
- deletions int -
- changes int -
- blob_url string -
- raw_url string -
- contents_url string -
- patch string? -
- previous_filename string? -
github: Discussion
A Discussion in a repository.
Fields
- active_lock_reason string -
- answer_chosen_at string -
- answer_chosen_by User -
- answer_html_url string -
- author_association "COLLABORATOR"|"CONTRIBUTOR"|"FIRST_TIMER"|"FIRST_TIME_CONTRIBUTOR"|"MANNEQUIN"|"MEMBER"|"NONE"|"OWNER" - How the author is associated with the repository.
- body string -
- category Discussion_category -
- comments int -
- created_at string -
- html_url string -
- id int -
- locked boolean -
- node_id string -
- number int -
- reactions Reactions? -
- repository_url string -
- state "open"|"closed"|"locked"|"converting"|"transferring" - The current state of the discussion.
converting
means that the discussion is being converted from an issue.transferring
means that the discussion is being transferred from another repository.
- state_reason "resolved"|"outdated"|"duplicate"|"reopened" - The reason for the current state
- timeline_url string? -
- title string -
- updated_at string -
- user User -
github: Discussion_category
Fields
- created_at string -
- description string -
- emoji string -
- id int -
- is_answerable boolean -
- name string -
- node_id string? -
- repository_id int -
- slug string -
- updated_at string -
github: Discussion_number_comments_body
Fields
- body string - The discussion comment's body text.
github: Discussion_number_comments_body_1
Fields
- body string - The discussion comment's body text.
github: Discussion_number_reactions_body
Fields
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes" - The reaction type to add to the team discussion.
github: Discussion_number_reactions_body_1
Fields
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes" - The reaction type to add to the team discussion.
github: Discussions_discussion_number_body
Fields
- title string? - The discussion post's title.
- body string? - The discussion post's body text.
github: Discussions_discussion_number_body_1
Fields
- title string? - The discussion post's title.
- body string? - The discussion post's body text.
github: DockerMetadata
Fields
- tag string[]? -
github: Email
Fields
- email string -
- primary boolean -
- verified boolean -
- visibility string -
github: Email_visibility_body
Fields
- visibility "public"|"private" - Denotes whether an email is publicly visible.
github: EmptyObject
An object without any properties.
github: Enterprise
An enterprise on GitHub.
Fields
- description string? - A short description of the enterprise.
- html_url string -
- website_url string? - The enterprise's website URL.
- id int - Unique identifier of the enterprise
- node_id string -
- name string - The name of the enterprise.
- slug string - The slug url identifier for the enterprise.
- created_at string -
- updated_at string -
- avatar_url string -
github: Environment
Details of a deployment environment
Fields
- id int - The id of the environment.
- node_id string -
- name string - The name of the environment.
- url string -
- html_url string -
- created_at string - The time that the environment was created, in ISO 8601 format.
- updated_at string - The time that the environment was last updated, in ISO 8601 format.
- protection_rules (record { id int, node_id string, 'type string, wait_timer WaitTimer }|record { id int, node_id string, prevent_self_review boolean, 'type string, reviewers record { 'type DeploymentReviewerType, reviewer SimpleUser|Team }[] }|record { id int, node_id string, 'type string })[]? - Built-in deployment protection rules for the environment.
- deployment_branch_policy DeploymentBranchPolicySettings? - The type of deployment branch policy for this environment. To allow all branches to deploy, set to
null
.
github: Environment_name_deployment_protection_rules_body
Fields
- integration_id int? - The ID of the custom app that will be enabled on the environment.
github: Environment_name_variables_body
Fields
- name string - The name of the variable.
- value string - The value of the variable.
github: EnvironmentApprovals
An entry in the reviews log for environment deployments
Fields
- environments Environmentapprovals_environments[] - The list of environments that were approved or rejected
- state "approved"|"rejected"|"pending" - Whether deployment to the environment(s) was approved or rejected or pending (with comments)
- user SimpleUser - A GitHub user.
- comment string - The comment submitted with the deployment review
github: Environmentapprovals_environments
Fields
- id int? - The id of the environment.
- node_id string? -
- name string? - The name of the environment.
- url string? -
- html_url string? -
- created_at string? - The time that the environment was created, in ISO 8601 format.
- updated_at string? - The time that the environment was last updated, in ISO 8601 format.
github: EnvironmentResponse
Details of a deployment environment
Fields
- total_count int? - The number of environments in this repository
- environments Environment[]? -
github: Environments_environment_name_body
Fields
- wait_timer WaitTimer? - The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
- prevent_self_review PreventSelfReview? - Whether or not a user who created the job is prevented from approving their own job.
- reviewers Reposownerrepoenvironmentsenvironment_name_reviewers[]? - The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
- deployment_branch_policy DeploymentBranchPolicySettings? - The type of deployment branch policy for this environment. To allow all branches to deploy, set to
null
.
github: Event
Event
Fields
- id string -
- 'type string -
- actor Actor - Actor
- repo Event_repo -
- org Actor? - Actor
- payload Event_payload -
- 'public boolean -
- created_at string -
github: Event_payload
Fields
- action string? -
- issue Issue? - Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
- comment IssueComment? - Comments provide a way for people to collaborate on an issue.
- pages Event_payload_pages[]? -
github: Event_payload_pages
Fields
- page_name string? -
- title string? -
- summary string? -
- action string? -
- sha string? -
- html_url string? -
github: Event_repo
Fields
- id int -
- name string -
- url string -
github: Feed
Feed
Fields
- timeline_url string -
- user_url string -
- current_user_public_url string? -
- current_user_url string? -
- current_user_actor_url string? -
- current_user_organization_url string? -
- current_user_organization_urls string[]? -
- security_advisories_url string? -
- repository_discussions_url string? - A feed of discussions for a given repository.
- repository_discussions_category_url string? - A feed of discussions for a given repository and category.
- _links Feed__links -
github: Feed__links
Fields
- timeline LinkWithType - Hypermedia Link with Type
- user LinkWithType - Hypermedia Link with Type
- security_advisories LinkWithType? - Hypermedia Link with Type
- current_user LinkWithType? - Hypermedia Link with Type
- current_user_public LinkWithType? - Hypermedia Link with Type
- current_user_actor LinkWithType? - Hypermedia Link with Type
- current_user_organization LinkWithType? - Hypermedia Link with Type
- current_user_organizations LinkWithType[]? -
- repository_discussions LinkWithType? - Hypermedia Link with Type
- repository_discussions_category LinkWithType? - Hypermedia Link with Type
github: FileCommit
File Commit
Fields
- content Filecommit_content -
- 'commit Filecommit_commit -
github: Filecommit_commit
Fields
- sha string? -
- node_id string? -
- url string? -
- html_url string? -
- author Filecommit_commit_author? -
- committer Filecommit_commit_author? -
- message string? -
- tree Filecommit_commit_tree? -
- parents Filecommit_commit_parents[]? -
- verification Filecommit_commit_verification? -
github: Filecommit_commit_author
Fields
- date string? -
- name string? -
- email string? -
github: Filecommit_commit_parents
Fields
- url string? -
- html_url string? -
- sha string? -
github: Filecommit_commit_tree
Fields
- url string? -
- sha string? -
github: Filecommit_commit_verification
Fields
- verified boolean? -
- reason string? -
- signature string? -
- payload string? -
github: Filecommit_content
Fields
- name string? -
- path string? -
- sha string? -
- size int? -
- url string? -
- html_url string? -
- git_url string? -
- download_url string? -
- 'type string? -
- _links Filecommit_content__links? -
github: Filecommit_content__links
Fields
- self string? -
- git string? -
- html string? -
github: FullRepository
Full Repository
Fields
- id int -
- node_id string -
- name string -
- full_name string -
- owner SimpleUser - A GitHub user.
- 'private boolean -
- html_url string -
- description string -
- 'fork boolean -
- url string -
- archive_url string -
- assignees_url string -
- blobs_url string -
- branches_url string -
- collaborators_url string -
- comments_url string -
- commits_url string -
- compare_url string -
- contents_url string -
- contributors_url string -
- deployments_url string -
- downloads_url string -
- events_url string -
- forks_url string -
- git_commits_url string -
- git_refs_url string -
- git_tags_url string -
- git_url string -
- issue_comment_url string -
- issue_events_url string -
- issues_url string -
- keys_url string -
- labels_url string -
- languages_url string -
- merges_url string -
- milestones_url string -
- notifications_url string -
- pulls_url string -
- releases_url string -
- ssh_url string -
- stargazers_url string -
- statuses_url string -
- subscribers_url string -
- subscription_url string -
- tags_url string -
- teams_url string -
- trees_url string -
- clone_url string -
- mirror_url string -
- hooks_url string -
- svn_url string -
- homepage string -
- language string -
- forks_count int -
- stargazers_count int -
- watchers_count int -
- size int - The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- default_branch string -
- open_issues_count int -
- is_template boolean? -
- topics string[]? -
- has_issues boolean -
- has_projects boolean -
- has_wiki boolean -
- has_pages boolean -
- has_downloads boolean? -
- has_discussions boolean -
- archived boolean -
- disabled boolean - Returns whether or not this repository disabled.
- visibility string? - The repository visibility: public, private, or internal.
- pushed_at string -
- created_at string -
- updated_at string -
- permissions Fullrepository_permissions? -
- allow_rebase_merge boolean? -
- template_repository NullableRepository? - A repository on GitHub.
- temp_clone_token string? -
- allow_squash_merge boolean? -
- allow_auto_merge boolean? -
- delete_branch_on_merge boolean? -
- allow_merge_commit boolean? -
- allow_update_branch boolean? -
- use_squash_pr_title_as_default boolean? -
- squash_merge_commit_title "PR_TITLE"|"COMMIT_OR_PR_TITLE" ? - The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- squash_merge_commit_message "PR_BODY"|"COMMIT_MESSAGES"|"BLANK" ? - The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- merge_commit_title "PR_TITLE"|"MERGE_MESSAGE" ? - The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- merge_commit_message "PR_BODY"|"PR_TITLE"|"BLANK" ? - The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- allow_forking boolean? -
- web_commit_signoff_required boolean? -
- subscribers_count int -
- network_count int -
- license NullableLicenseSimple - License Simple
- organization NullableSimpleUser? - A GitHub user.
- parent Repository? - A repository on GitHub.
- 'source Repository? - A repository on GitHub.
- forks int -
- master_branch string? -
- open_issues int -
- watchers int -
- anonymous_access_enabled boolean(default true) - Whether anonymous git access is allowed.
- code_of_conduct CodeOfConductSimple? - Code of Conduct Simple
- security_and_analysis SecurityAndAnalysis? -
github: Fullrepository_permissions
Fields
- admin boolean -
- maintain boolean? -
- push boolean -
- triage boolean? -
- pull boolean -
github: Gist
Gist
Fields
- url string -
- forks_url string -
- commits_url string -
- id string -
- node_id string -
- git_pull_url string -
- git_push_url string -
- html_url string -
- files record { Basegist_files... } -
- 'public boolean -
- created_at string -
- updated_at string -
- description string -
- comments int -
- user NullableSimpleUser - A GitHub user.
- comments_url string -
- owner NullableSimpleUser? - A GitHub user.
- truncated boolean? -
- forks anydata[]? -
- history anydata[]? -
github: Gist_id_comments_body
Fields
- body string - The comment text.
github: GistComment
A comment made to a gist.
Fields
- id int -
- node_id string -
- url string -
- body string - The comment text.
- user NullableSimpleUser - A GitHub user.
- created_at string -
- updated_at string -
- author_association AuthorAssociation - How the author is associated with the repository.
github: GistCommit
Gist Commit
Fields
- url string -
- version string -
- user NullableSimpleUser - A GitHub user.
- change_status Gisthistory_change_status -
- committed_at string -
github: GistHistory
Gist History
Fields
- user NullableSimpleUser? - A GitHub user.
- version string? -
- committed_at string? -
- change_status Gisthistory_change_status? -
- url string? -
github: Gisthistory_change_status
Fields
- total int? -
- additions int? -
- deletions int? -
github: Gists_body
Fields
- description string? - Description of the gist
- files record { Gists_files... } - Names and content for the files that make up the gist
- 'public boolean|"true"|"false" ? -
github: Gists_files
Fields
- content string - Content of the file
github: Gists_gist_id_body
Fields
- description string? - The description of the gist.
- files record { Gistsgist_id_files?... }? - The gist files to be updated, renamed, or deleted. Each
key
must match the current filename (including extension) of the targeted gist file. For example:hello.py
. To delete a file, set the whole file to null. For example:hello.py : null
. The file will also be deleted if the specified object does not contain at least one ofcontent
orfilename
.
github: Gistsgist_id_files
Fields
- content string? - The new content of the file.
- filename string? - The new filename for the file.
github: GistSimple
Gist Simple
Fields
- forks Gistsimple_forks[]? -
- history GistHistory[]? -
- fork_of Gist? - Gist
- url string? -
- forks_url string? -
- commits_url string? -
- id string? -
- node_id string? -
- git_pull_url string? -
- git_push_url string? -
- html_url string? -
- files record { Gistsimple_files?... }? -
- 'public boolean? -
- created_at string? -
- updated_at string? -
- description string? -
- comments int? -
- user string? -
- comments_url string? -
- owner SimpleUser? - A GitHub user.
- truncated boolean? -
github: Gistsimple_files
Fields
- filename string? -
- 'type string? -
- language string? -
- raw_url string? -
- size int? -
- truncated boolean? -
- content string? -
github: Gistsimple_forks
Fields
- id string? -
- url string? -
- user PublicUser? - Public User
- created_at string? -
- updated_at string? -
github: Git_blobs_body
Fields
- content string - The new blob's content.
- encoding string(default "utf-8") - The encoding used for
content
. Currently,"utf-8"
and"base64"
are supported.
github: Git_commits_body
Fields
- message string - The commit message
- tree string - The SHA of the tree object this commit points to
- parents string[]? - The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.
- author Reposownerrepogitcommits_author? - Information about the author of the commit. By default, the
author
will be the authenticated user and the current date. See theauthor
andcommitter
object below for details.
- committer Reposownerrepogitcommits_committer? - Information about the person who is making the commit. By default,
committer
will use the information set inauthor
. See theauthor
andcommitter
object below for details.
- signature string? - The PGP signature of the commit. GitHub adds the signature to the
gpgsig
header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass asignature
parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.
github: Git_refs_body
Fields
- ref string - The name of the fully qualified reference (ie:
refs/heads/master
). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
- sha string - The SHA1 value for this reference.
github: Git_tags_body
Fields
- tag string - The tag's name. This is typically a version (e.g., "v0.0.1").
- message string - The tag message.
- 'object string - The SHA of the git object this is tagging.
- 'type "commit"|"tree"|"blob" - The type of the object we're tagging. Normally this is a
commit
but it can also be atree
or ablob
.
- tagger Reposownerrepogittags_tagger? - An object with information about the individual creating the tag.
github: Git_trees_body
Fields
- tree Reposownerrepogittrees_tree[] - Objects (of
path
,mode
,type
, andsha
) specifying a tree structure.
- base_tree string? - The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by
base_tree
and entries defined in thetree
parameter. Entries defined in thetree
parameter will overwrite items frombase_tree
with the samepath
. If you're creating new changes on a branch, then normally you'd setbase_tree
to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. If not provided, GitHub will create a new Git tree object from only the entries defined in thetree
parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in thetree
parameter will be listed as deleted by the new commit.
github: GitCommit
Low-level Git commit operations within a repository
Fields
- sha string - SHA for the commit
- node_id string -
- url string -
- author Gitcommit_author - Identifying information for the git-user
- committer Gitcommit_author - Identifying information for the git-user
- message string - Message describing the purpose of the commit
- tree Gitcommit_tree -
- parents Gitcommit_parents[] -
- verification Gitcommit_verification -
- html_url string -
github: Gitcommit_author
Identifying information for the git-user
Fields
- date string - Timestamp of the commit
- email string - Git email address of the user
- name string - Name of the git user
github: Gitcommit_parents
Fields
- sha string - SHA for the commit
- url string -
- html_url string -
github: Gitcommit_tree
Fields
- sha string - SHA for the commit
- url string -
github: Gitcommit_verification
Fields
- verified boolean -
- reason string -
- signature string -
- payload string -
github: GitignoreTemplate
Gitignore Template
Fields
- name string -
- 'source string -
github: GitRef
Git references within a repository
Fields
- ref string -
- node_id string -
- url string -
- 'object Gitref_object -
github: Gitref_object
Fields
- 'type string -
- sha string - SHA for the reference
- url string -
github: GitTag
Metadata for a Git tag
Fields
- node_id string -
- tag string - Name of the tag
- sha string -
- url string - URL for the tag
- message string - Message describing the purpose of the tag
- tagger Gittag_tagger -
- 'object Gittag_object -
- verification Verification? -
github: Gittag_object
Fields
- sha string -
- 'type string -
- url string -
github: Gittag_tagger
Fields
- date string -
- email string -
- name string -
github: GitTree
The hierarchy between files in a Git repository.
Fields
- sha string -
- url string -
- truncated boolean -
- tree Gittree_tree[] - Objects specifying a tree structure
github: Gittree_tree
Fields
- path string? -
- mode string? -
- 'type string? -
- sha string? -
- size int? -
- url string? -
github: GlobalAdvisory
A GitHub Security Advisory.
Fields
- ghsa_id string - The GitHub Security Advisory ID.
- cve_id string - The Common Vulnerabilities and Exposures (CVE) ID.
- url string - The API URL for the advisory.
- html_url string - The URL for the advisory.
- repository_advisory_url string - The API URL for the repository advisory.
- summary string - A short summary of the advisory.
- description string - A detailed description of what the advisory entails.
- 'type "reviewed"|"unreviewed"|"malware" - The type of advisory.
- severity "critical"|"high"|"medium"|"low"|"unknown" - The severity of the advisory.
- source_code_location string - The URL of the advisory's source code.
- identifiers Globaladvisory_identifiers[] -
- references string[] -
- published_at string - The date and time of when the advisory was published, in ISO 8601 format.
- updated_at string - The date and time of when the advisory was last updated, in ISO 8601 format.
- github_reviewed_at string - The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.
- nvd_published_at string - The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. This field is only populated when the advisory is imported from the National Vulnerability Database.
- withdrawn_at string - The date and time of when the advisory was withdrawn, in ISO 8601 format.
- vulnerabilities Globaladvisory_vulnerabilities[] - The products and respective version ranges affected by the advisory.
- cvss Globaladvisory_cvss -
- cwes Globaladvisory_cwes[] -
- credits Globaladvisory_credits[] - The users who contributed to the advisory.
github: Globaladvisory_credits
Fields
- user SimpleUser - A GitHub user.
- 'type SecurityAdvisoryCreditTypes - The type of credit the user is receiving.
github: Globaladvisory_cvss
Fields
- vector_string string - The CVSS vector.
- score decimal - The CVSS score.
github: Globaladvisory_cwes
Fields
- cwe_id string - The Common Weakness Enumeration (CWE) identifier.
- name string - The name of the CWE.
github: Globaladvisory_identifiers
Fields
- 'type "CVE"|"GHSA" - The type of identifier.
- value string - The identifier value.
github: Globaladvisory_package
The name of the package affected by the vulnerability.
Fields
- ecosystem SecurityAdvisoryEcosystems - The package's language or package management ecosystem.
- name string - The unique package name within its ecosystem.
github: Globaladvisory_vulnerabilities
Fields
- package Globaladvisory_package - The name of the package affected by the vulnerability.
- vulnerable_version_range string - The range of the package versions affected by the vulnerability.
- first_patched_version string - The package version that resolve the vulnerability.
- vulnerable_functions string[] - The functions in the package that are affected by the vulnerability.
github: GpgKey
A unique encryption key
Fields
- id int -
- name string? -
- primary_key_id int -
- key_id string -
- public_key string -
- emails Gpgkey_emails[] -
- subkeys Gpgkey_subkeys[] -
- can_sign boolean -
- can_encrypt_comms boolean -
- can_encrypt_storage boolean -
- can_certify boolean -
- created_at string -
- expires_at string -
- revoked boolean -
- raw_key string -
github: Gpgkey_emails
Fields
- email string? -
- verified boolean? -
github: Gpgkey_subkeys
Fields
- id int? -
- primary_key_id int? -
- key_id string? -
- public_key string? -
- emails Gpgkey_emails[]? -
- subkeys anydata[]? -
- can_sign boolean? -
- can_encrypt_comms boolean? -
- can_encrypt_storage boolean? -
- can_certify boolean? -
- created_at string? -
- expires_at string? -
- raw_key string? -
- revoked boolean? -
github: Hook
Webhooks for repositories.
Fields
- 'type string -
- id int - Unique identifier of the webhook.
- name string - The name of a valid service, use 'web' for a webhook.
- active boolean - Determines whether the hook is actually triggered on pushes.
- events string[] - Determines what events the hook is triggered for. Default: ['push'].
- config Hook_config -
- updated_at string -
- created_at string -
- url string -
- test_url string -
- ping_url string -
- deliveries_url string? -
- last_response HookResponse -
github: Hook_config
Fields
- email string? -
- password string? -
- room string? -
- subdomain string? -
- url WebhookConfigUrl? - The URL to which the payloads will be delivered.
- insecure_ssl WebhookConfigInsecureSsl? -
- content_type WebhookConfigContentType? - The media type used to serialize the payloads. Supported values include
json
andform
. The default isform
.
- digest string? -
- secret WebhookConfigSecret? - If provided, the
secret
will be used as thekey
to generate the HMAC hex digest value for delivery signature headers.
- token string? -
github: Hook_config_body
Fields
- url WebhookConfigUrl? - The URL to which the payloads will be delivered.
- content_type WebhookConfigContentType? - The media type used to serialize the payloads. Supported values include
json
andform
. The default isform
.
- secret WebhookConfigSecret? - If provided, the
secret
will be used as thekey
to generate the HMAC hex digest value for delivery signature headers.
- insecure_ssl WebhookConfigInsecureSsl? -
github: Hook_id_config_body
Fields
- url WebhookConfigUrl? - The URL to which the payloads will be delivered.
- content_type WebhookConfigContentType? - The media type used to serialize the payloads. Supported values include
json
andform
. The default isform
.
- secret WebhookConfigSecret? - If provided, the
secret
will be used as thekey
to generate the HMAC hex digest value for delivery signature headers.
- insecure_ssl WebhookConfigInsecureSsl? -
github: Hook_id_config_body_1
Fields
- url WebhookConfigUrl? - The URL to which the payloads will be delivered.
- content_type WebhookConfigContentType? - The media type used to serialize the payloads. Supported values include
json
andform
. The default isform
.
- secret WebhookConfigSecret? - If provided, the
secret
will be used as thekey
to generate the HMAC hex digest value for delivery signature headers.
- insecure_ssl WebhookConfigInsecureSsl? -
github: HookDelivery
Delivery made by a webhook.
Fields
- id int - Unique identifier of the delivery.
- guid string - Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).
- delivered_at string - Time when the delivery was delivered.
- redelivery boolean - Whether the delivery is a redelivery.
- duration decimal - Time spent delivering.
- status string - Description of the status of the attempted delivery
- status_code int - Status code received when delivery was made.
- event string - The event that triggered the delivery.
- action string - The type of activity for the event that triggered the delivery.
- installation_id int - The id of the GitHub App installation associated with this event.
- repository_id int - The id of the repository associated with this event.
- url string? - The URL target of the delivery.
- request Hookdelivery_request -
- response Hookdelivery_response -
github: Hookdelivery_request
Fields
- headers record {} - The request headers sent with the webhook delivery.
- payload record {} - The webhook payload.
github: Hookdelivery_response
Fields
- headers record {} - The response headers received when the delivery was made.
- payload record {} - The response payload received.
github: HookDeliveryItem
Delivery made by a webhook, without request and response information.
Fields
- id int - Unique identifier of the webhook delivery.
- guid string - Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).
- delivered_at string - Time when the webhook delivery occurred.
- redelivery boolean - Whether the webhook delivery is a redelivery.
- duration decimal - Time spent delivering.
- status string - Describes the response returned after attempting the delivery.
- status_code int - Status code received when delivery was made.
- event string - The event that triggered the delivery.
- action string - The type of activity for the event that triggered the delivery.
- installation_id int - The id of the GitHub App installation associated with this event.
- repository_id int - The id of the repository associated with this event.
github: HookResponse
Fields
- code int -
- status string -
- message string -
github: Hooks_hook_id_body
Fields
- config Orgsorghookshook_id_config? - Key/value pairs to provide settings for this webhook.
- active boolean? - Determines if notifications are sent when the webhook is triggered. Set to
true
to send notifications.
- name string? -
github: Hooks_hook_id_body_1
Fields
- config Reposownerrepohookshook_id_config? - Key/value pairs to provide settings for this webhook.
- add_events string[]? - Determines a list of events to be added to the list of events that the Hook triggers for.
- remove_events string[]? - Determines a list of events to be removed from the list of events that the Hook triggers for.
- active boolean? - Determines if notifications are sent when the webhook is triggered. Set to
true
to send notifications.
github: Hovercard
Hovercard
Fields
- contexts Hovercard_contexts[] -
github: Hovercard_contexts
Fields
- message string -
- octicon string -
github: Import
A repository import from an external source.
Fields
- vcs string -
- use_lfs boolean? -
- vcs_url string - The URL of the originating repository.
- svc_root string? -
- tfvc_project string? -
- status "auth"|"error"|"none"|"detecting"|"choose"|"auth_failed"|"importing"|"mapping"|"waiting_to_push"|"pushing"|"complete"|"setup"|"unknown"|"detection_found_multiple"|"detection_found_nothing"|"detection_needs_auth" -
- status_text string? -
- failed_step string? -
- error_message string? -
- import_percent int? -
- commit_count int? -
- push_percent int? -
- has_large_files boolean? -
- large_files_size int? -
- large_files_count int? -
- project_choices Import_project_choices[]? -
- message string? -
- authors_count int? -
- url string -
- html_url string -
- authors_url string -
- repository_url string -
- svn_root string? -
github: Import_lfs_body
Fields
- use_lfs "opt_in"|"opt_out" - Whether to store large files during the import.
opt_in
means large files will be stored using Git LFS.opt_out
means large files will be removed during the import.
github: Import_project_choices
Fields
- vcs string? -
- tfvc_project string? -
- human_name string? -
github: Inline_response_403
Fields
- block Inline_response_403_block? -
- message string? -
- documentation_url string? -
github: Inline_response_403_1
Fields
- message string? -
- documentation_url string? -
- errors string[]? -
github: Inline_response_403_2
Fields
- message string? -
- documentation_url string? -
- errors Inline_response_403_2_errors[]? -
github: Inline_response_403_2_errors
Fields
- code string? -
- message string? -
- 'resource string? -
- 'field string? -
github: Inline_response_403_block
Fields
- reason string? -
- created_at string? -
- html_url string? -
github: Inline_response_422_1
Fields
- message string? -
- documentation_url string? -
github: Inline_response_503
Fields
- code string? -
- message string? -
- documentation_url string? -
github: Inline_response_503_1
Fields
- code string? -
- message string? -
- documentation_url string? -
- errors Inline_response_503_1_errors[]? -
github: Inline_response_503_1_errors
Fields
- code string? -
- message string? -
github: Installation
Installation
Fields
- id int - The ID of the installation.
- account SimpleUser|Enterprise? -
- repository_selection "all"|"selected" - Describe whether all repositories have been selected or there's a selection involved
- access_tokens_url string -
- repositories_url string -
- html_url string -
- app_id int -
- target_id int - The ID of the user or organization this token is being scoped to.
- target_type string -
- permissions AppPermissions - The permissions granted to the user access token.
- events string[] -
- created_at string -
- updated_at string -
- single_file_name string -
- has_multiple_single_files boolean? -
- single_file_paths string[]? -
- app_slug string -
- suspended_by NullableSimpleUser - A GitHub user.
- suspended_at string -
- contact_email string? -
github: Installation_id_access_tokens_body
Fields
- repositories string[]? - List of repository names that the token should have access to
- repository_ids int[]? - List of repository IDs that the token should have access to
- permissions AppPermissions? - The permissions granted to the user access token.
github: InstallationResponse
Installation
Fields
- total_count int -
- installations Installation[] -
github: InstallationToken
Authentication token for a GitHub App installed on a user or org.
Fields
- token string -
- expires_at string -
- permissions AppPermissions? - The permissions granted to the user access token.
- repository_selection "all"|"selected" ? -
- repositories Repository[]? -
- single_file string? -
- has_multiple_single_files boolean? -
- single_file_paths string[]? -
github: Integration
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
Fields
- id int - Unique identifier of the GitHub app
- slug string? - The slug name of the GitHub app
- node_id string -
- owner NullableSimpleUser - A GitHub user.
- name string - The name of the GitHub app
- description string -
- external_url string -
- html_url string -
- created_at string -
- updated_at string -
- permissions Integration_permissions - The set of permissions for the GitHub app
- events string[] - The list of events for the GitHub app
- installations_count int? - The number of installations associated with the GitHub app
- client_id string? -
- client_secret string? -
- webhook_secret string? -
- pem string? -
github: Integration_permissions
The set of permissions for the GitHub app
Fields
- issues string? -
- checks string? -
- metadata string? -
- contents string? -
- deployments string? -
- string... - Rest field
github: IntegrationInstallationRequest
Request to install an integration on a target
Fields
- id int - Unique identifier of the request installation.
- node_id string? -
- account SimpleUser|Enterprise -
- requester SimpleUser - A GitHub user.
- created_at string -
github: InteractionLimit
Limit interactions to a specific type of user for a specified duration
Fields
- 'limit InteractionGroup - The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
- expiry InteractionExpiry? - The duration of the interaction restriction. Default:
one_day
.
github: InteractionLimitResponse
Interaction limit settings.
Fields
- 'limit InteractionGroup - The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
- origin string -
- expires_at string -
github: Invitations_invitation_id_body
Fields
- permissions "read"|"write"|"maintain"|"triage"|"admin" ? - The permissions that the associated user will have on the repository. Valid values are
read
,write
,maintain
,triage
, andadmin
.
github: Issue
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
Fields
- id int -
- node_id string -
- url string - URL for the issue
- repository_url string -
- labels_url string -
- comments_url string -
- events_url string -
- html_url string -
- number int - Number uniquely identifying the issue within its repository
- state string - State of the issue; either 'open' or 'closed'
- state_reason "completed"|"reopened"|"not_planned"?? - The reason for the current state
- title string - Title of the issue
- body string? - Contents of the issue
- user NullableSimpleUser - A GitHub user.
- labels (string|record { id int, node_id string, url string, name string, description string?, color string?, default boolean })[] - Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
- assignee NullableSimpleUser - A GitHub user.
- assignees SimpleUser[]? -
- milestone NullableMilestone - A collection of related issues and pull requests.
- locked boolean -
- active_lock_reason string? -
- comments int -
- pull_request Issue_pull_request? -
- closed_at string -
- created_at string -
- updated_at string -
- draft boolean? -
- closed_by NullableSimpleUser? - A GitHub user.
- body_html string? -
- body_text string? -
- timeline_url string? -
- repository Repository? - A repository on GitHub.
- performed_via_github_app NullableIntegration? - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- author_association AuthorAssociation - How the author is associated with the repository.
- reactions ReactionRollup? -
github: Issue_number_assignees_body
Fields
- assignees string[]? - Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.
github: Issue_number_assignees_body_1
Fields
- assignees string[]? - Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.
github: Issue_number_comments_body
Fields
- body string - The contents of the comment.
github: Issue_number_lock_body
Fields
- lock_reason "off-topic"|"too heated"|"resolved"|"spam" ? - The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
off-topic
too heated
resolved
spam
github: Issue_number_reactions_body
Fields
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes" - The reaction type to add to the issue.
github: Issue_pull_request
Fields
- merged_at string? -
- diff_url string -
- html_url string -
- patch_url string -
- url string -
github: IssueComment
Comments provide a way for people to collaborate on an issue.
Fields
- id int - Unique identifier of the issue comment
- node_id string -
- url string - URL for the issue comment
- body string? - Contents of the issue comment
- body_text string? -
- body_html string? -
- html_url string -
- user NullableSimpleUser - A GitHub user.
- created_at string -
- updated_at string -
- issue_url string -
- author_association AuthorAssociation - How the author is associated with the repository.
- performed_via_github_app NullableIntegration? - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- reactions ReactionRollup? -
github: IssueEvent
Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor NullableSimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- issue NullableIssue? - Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
- label IssueEventLabel? - Issue Event Label
- assignee NullableSimpleUser? - A GitHub user.
- assigner NullableSimpleUser? - A GitHub user.
- review_requester NullableSimpleUser? - A GitHub user.
- requested_reviewer NullableSimpleUser? - A GitHub user.
- requested_team Team? - Groups of organization members that gives permissions on specified repositories.
- dismissed_review IssueEventDismissedReview? -
- milestone IssueEventMilestone? - Issue Event Milestone
- project_card IssueEventProjectCard? - Issue Event Project Card
- rename IssueEventRename? - Issue Event Rename
- author_association AuthorAssociation? - How the author is associated with the repository.
- lock_reason string? -
- performed_via_github_app NullableIntegration? - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
github: IssueEventDismissedReview
Fields
- state string -
- review_id int -
- dismissal_message string -
- dismissal_commit_id string? -
github: IssueEventLabel
Issue Event Label
Fields
- name string -
- color string -
github: IssueEventMilestone
Issue Event Milestone
Fields
- title string -
github: IssueEventProjectCard
Issue Event Project Card
Fields
- url string -
- id int -
- project_url string -
- project_id int -
- column_name string -
- previous_column_name string? -
github: IssueEventRename
Issue Event Rename
Fields
- 'from string -
- to string -
github: Issues_issue_number_body
Fields
- body string? - The contents of the issue.
- assignee string? - Username to assign to this issue. This field is deprecated.
- state "open"|"closed" ? - The open or closed state of the issue.
- state_reason "completed"|"not_planned"|"reopened" ? - The reason for the state change. Ignored unless
state
is changed.
- labels (string|record { id int, name string, description string?, color string? })[]? - Labels to associate with this issue. Pass one or more labels to replace the set of labels on this issue. Send an empty array (
[]
) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.
- assignees string[]? - Usernames to assign to this issue. Pass one or more user logins to replace the set of assignees on this issue. Send an empty array (
[]
) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.
github: IssueSearchResultItem
Issue Search Result Item
Fields
- url string -
- repository_url string -
- labels_url string -
- comments_url string -
- events_url string -
- html_url string -
- id int -
- node_id string -
- number int -
- title string -
- locked boolean -
- active_lock_reason string? -
- assignees SimpleUser[]? -
- user NullableSimpleUser - A GitHub user.
- labels Issuesearchresultitem_labels[] -
- state string -
- state_reason string? -
- assignee NullableSimpleUser - A GitHub user.
- milestone NullableMilestone - A collection of related issues and pull requests.
- comments int -
- created_at string -
- updated_at string -
- closed_at string -
- text_matches SearchResultTextMatches? -
- pull_request Issue_pull_request? -
- body string? -
- score decimal -
- author_association AuthorAssociation - How the author is associated with the repository.
- draft boolean? -
- repository Repository? - A repository on GitHub.
- body_html string? -
- body_text string? -
- timeline_url string? -
- performed_via_github_app NullableIntegration? - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- reactions ReactionRollup? -
github: Issuesearchresultitem_labels
Fields
- id int? -
- node_id string? -
- url string? -
- name string? -
- color string? -
- default boolean? -
- description string? -
github: IssueSearchResultItemResponse
Issue Search Result Item
Fields
- total_count int -
- incomplete_results boolean -
- items IssueSearchResultItem[] -
github: JitConfig
Fields
- runner Runner - A self hosted runner
- encoded_jit_config string - The base64 encoded runner configuration.
github: Job
Information of a job execution in a workflow run
Fields
- id int - The id of the job.
- run_id int - The id of the associated workflow run.
- run_url string -
- run_attempt int? - Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
- node_id string -
- head_sha string - The SHA of the commit that is being run.
- url string -
- html_url string -
- status "queued"|"in_progress"|"completed" - The phase of the lifecycle that the job is currently in.
- conclusion "success"|"failure"|"neutral"|"cancelled"|"skipped"|"timed_out"|"action_required" - The outcome of the job.
- created_at string - The time that the job created, in ISO 8601 format.
- started_at string - The time that the job started, in ISO 8601 format.
- completed_at string - The time that the job finished, in ISO 8601 format.
- name string - The name of the job.
- steps Job_steps[]? - Steps in this job.
- check_run_url string -
- labels string[] - Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
- runner_id int - The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- runner_name string - The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- runner_group_id int - The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- runner_group_name string - The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- workflow_name string - The name of the workflow.
- head_branch string - The name of the current branch.
github: Job_id_rerun_body
Fields
- enable_debug_logging boolean? - Whether to enable debug logging for the re-run.
github: Job_steps
Fields
- status "queued"|"in_progress"|"completed" - The phase of the lifecycle that the job is currently in.
- conclusion string - The outcome of the job.
- name string - The name of the job.
- number int -
- started_at string? - The time that the step started, in ISO 8601 format.
- completed_at string? - The time that the job finished, in ISO 8601 format.
github: JobResponse
Information of a job execution in a workflow run
Fields
- total_count int -
- jobs Job[] -
github: Key
Key
Fields
- 'key string -
- id int -
- url string -
- title string -
- created_at string -
- verified boolean -
- read_only boolean -
github: KeySimple
Key Simple
Fields
- id int -
- 'key string -
github: Label
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
Fields
- id int -
- node_id string -
- url string - URL for the label
- name string - The name of the label.
- description string -
- color string - 6-character hex code, without the leading #, identifying the color
- default boolean -
github: LabeledIssueEvent
Labeled Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- label Labeledissueevent_label -
github: Labeledissueevent_label
Fields
- name string -
- color string -
github: Labels_name_body
Fields
- new_name string? - The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing
:strawberry:
will render the emoji . For a full list of available emoji and codes, see "Emoji cheat sheet."
- color string? - The hexadecimal color code for the label, without the leading
#
.
- description string? - A short description of the label. Must be 100 characters or fewer.
github: LabelSearchResultItem
Label Search Result Item
Fields
- id int -
- node_id string -
- url string -
- name string -
- color string -
- default boolean -
- description string -
- score decimal -
- text_matches SearchResultTextMatches? -
github: LabelSearchResultItemResponse
Label Search Result Item
Fields
- total_count int -
- incomplete_results boolean -
- items LabelSearchResultItem[] -
github: Language
Language
Fields
- int... - Rest field
github: License
License
Fields
- 'key string -
- name string -
- spdx_id string -
- url string -
- node_id string -
- html_url string -
- description string -
- implementation string -
- permissions string[] -
- conditions string[] -
- limitations string[] -
- body string -
- featured boolean -
github: LicenseContent
License Content
Fields
- name string -
- path string -
- sha string -
- size int -
- url string -
- html_url string -
- git_url string -
- download_url string -
- 'type string -
- content string -
- encoding string -
- _links Contenttree__links -
- license NullableLicenseSimple - License Simple
github: LicenseSimple
License Simple
Fields
- 'key string -
- name string -
- url string -
- spdx_id string -
- node_id string -
- html_url string? -
github: Link
Hypermedia Link
Fields
- href string -
github: LinkWithType
Hypermedia Link with Type
Fields
- href string -
- 'type string -
github: LockedIssueEvent
Locked Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- lock_reason string -
github: Manifest
Fields
- name string - The name of the manifest.
- file Manifest_file? -
- metadata Metadata? - User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
- resolved record { Dependency... }? - A collection of resolved package dependencies.
github: Manifest_file
Fields
- source_location string? - The path of the manifest file relative to the root of the Git repository.
github: ManifestConversions
Fields
- Fields Included from *Integration
- id int
- slug string
- node_id string
- owner NullableSimpleUser|()
- name string
- description string|()
- external_url string
- html_url string
- created_at string
- updated_at string
- permissions Integration_permissions
- events string[]
- installations_count int
- client_id string
- client_secret string
- webhook_secret string|()
- pem string
- anydata...
- client_id string -
- client_secret string -
- webhook_secret string -
- pem string -
github: Markdown_body
Fields
- text string - The Markdown text to render in HTML.
- mode "markdown"|"gfm" (default "markdown") - The rendering mode.
- context string? - The repository context to use when creating references in
gfm
mode. For example, settingcontext
toocto-org/octo-repo
will change the text#42
into an HTML link to issue 42 in theocto-org/octo-repo
repository.
github: MarketplaceAccount
Fields
- url string -
- id int -
- 'type string -
- node_id string? -
- login string -
- email string? -
- organization_billing_email string? -
github: MarketplaceListingPlan
Marketplace Listing Plan
Fields
- url string -
- accounts_url string -
- id int -
- number int -
- name string -
- description string -
- monthly_price_in_cents int -
- yearly_price_in_cents int -
- price_model "FREE"|"FLAT_RATE"|"PER_UNIT" -
- has_free_trial boolean -
- unit_name string -
- state string -
- bullets string[] -
github: MarketplacePurchase
Marketplace Purchase
Fields
- url string -
- 'type string -
- id int -
- login string -
- organization_billing_email string? -
- email string? -
- marketplace_pending_change Marketplacepurchase_marketplace_pending_change? -
- marketplace_purchase Marketplacepurchase_marketplace_purchase -
github: Marketplacepurchase_marketplace_pending_change
Fields
- is_installed boolean? -
- effective_date string? -
- unit_count int? -
- id int? -
- plan MarketplaceListingPlan? - Marketplace Listing Plan
github: Marketplacepurchase_marketplace_purchase
Fields
- billing_cycle string? -
- next_billing_date string? -
- is_installed boolean? -
- unit_count int? -
- on_free_trial boolean? -
- free_trial_ends_on string? -
- updated_at string? -
- plan MarketplaceListingPlan? - Marketplace Listing Plan
github: Memberships_username_body
Fields
- role "admin"|"member" ? - The role to give the user in the organization. Can be one of:
admin
- The user will become an owner of the organization.member
- The user will become a non-owner member of the organization.
github: Memberships_username_body_1
Fields
- role "member"|"maintainer" ? - The role that this user should have in the team.
github: Memberships_username_body_2
Fields
- role "member"|"maintainer" ? - The role that this user should have in the team.
github: MergedBranchResponse
Merged branch response message
Fields
- message string? -
github: MergedUpstream
Results of a successful merge upstream request
Fields
- message string? -
- merge_type "merge"|"fast-forward"|"none" ? -
- base_branch string? -
github: Metadata
User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
github: Migration
A migration.
Fields
- id int -
- owner NullableSimpleUser - A GitHub user.
- guid string -
- state string -
- lock_repositories boolean -
- exclude_metadata boolean -
- exclude_git_data boolean -
- exclude_attachments boolean -
- exclude_releases boolean -
- exclude_owner_projects boolean -
- org_metadata_only boolean -
- repositories Repository[] - The repositories included in the migration. Only returned for export migrations.
- url string -
- created_at string -
- updated_at string -
- node_id string -
- archive_url string? -
- exclude string[]? - Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of:
"repositories"
.
github: Milestone
A collection of related issues and pull requests.
Fields
- url string -
- html_url string -
- labels_url string -
- id int -
- node_id string -
- number int - The number of the milestone.
- state "open"|"closed" - The state of the milestone.
- title string - The title of the milestone.
- description string -
- creator NullableSimpleUser - A GitHub user.
- open_issues int -
- closed_issues int -
- created_at string -
- updated_at string -
- closed_at string -
- due_on string -
github: MilestonedIssueEvent
Milestoned Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- milestone Milestonedissueevent_milestone -
github: Milestonedissueevent_milestone
Fields
- title string -
github: Milestones_milestone_number_body
Fields
- title string? - The title of the milestone.
- state "open"|"closed" ? - The state of the milestone. Either
open
orclosed
.
- description string? - A description of the milestone.
github: MinimalRepository
Minimal Repository
Fields
- id int -
- node_id string -
- name string -
- full_name string -
- owner SimpleUser - A GitHub user.
- 'private boolean -
- html_url string -
- description string -
- 'fork boolean -
- url string -
- archive_url string -
- assignees_url string -
- blobs_url string -
- branches_url string -
- collaborators_url string -
- comments_url string -
- commits_url string -
- compare_url string -
- contents_url string -
- contributors_url string -
- deployments_url string -
- downloads_url string -
- events_url string -
- forks_url string -
- git_commits_url string -
- git_refs_url string -
- git_tags_url string -
- git_url string? -
- issue_comment_url string -
- issue_events_url string -
- issues_url string -
- keys_url string -
- labels_url string -
- languages_url string -
- merges_url string -
- milestones_url string -
- notifications_url string -
- pulls_url string -
- releases_url string -
- ssh_url string? -
- stargazers_url string -
- statuses_url string -
- subscribers_url string -
- subscription_url string -
- tags_url string -
- teams_url string -
- trees_url string -
- clone_url string? -
- mirror_url string? -
- hooks_url string -
- svn_url string? -
- homepage string? -
- language string? -
- forks_count int? -
- stargazers_count int? -
- watchers_count int? -
- size int? - The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- default_branch string? -
- open_issues_count int? -
- is_template boolean? -
- topics string[]? -
- has_issues boolean? -
- has_projects boolean? -
- has_wiki boolean? -
- has_pages boolean? -
- has_downloads boolean? -
- has_discussions boolean? -
- archived boolean? -
- disabled boolean? -
- visibility string? -
- pushed_at string? -
- created_at string? -
- updated_at string? -
- permissions Repository_template_repository_permissions? -
- role_name string? -
- temp_clone_token string? -
- delete_branch_on_merge boolean? -
- subscribers_count int? -
- network_count int? -
- code_of_conduct CodeOfConduct? - Code Of Conduct
- license Minimalrepository_license? -
- forks int? -
- open_issues int? -
- watchers int? -
- allow_forking boolean? -
- web_commit_signoff_required boolean? -
- security_and_analysis SecurityAndAnalysis? -
github: Minimalrepository_license
Fields
- 'key string? -
- name string? -
- spdx_id string? -
- url string? -
- node_id string? -
github: MinimalRepositoryResponse
Minimal Repository
Fields
- total_count int -
- repositories MinimalRepository[] -
github: MovedColumnInProjectIssueEvent
Moved Column in Project Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- project_card Addedtoprojectissueevent_project_card? -
github: Name_repositories_body
Fields
- selected_repository_ids int[] - The IDs of the repositories that can access the organization variable.
github: NotificationRead
Fields
- message string? -
- url string? -
github: Notifications_body
Fields
- last_read_at string? - Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
. Default: The current timestamp.
- read boolean? - Whether the notification has been read.
github: NotificationThread
Thread
Fields
- id string -
- repository MinimalRepository - Minimal Repository
- subject Notificationthread_subject -
- reason string -
- unread boolean -
- updated_at string -
- last_read_at string -
- url string -
- subscription_url string -
github: Notificationthread_subject
Fields
- title string -
- url string -
- latest_comment_url string -
- 'type string -
github: NullableCodeOfConductSimple
Code of Conduct Simple
Fields
- url string -
- 'key string -
- name string -
- html_url string -
github: NullableCodespaceMachine
A description of the machine powering a codespace.
Fields
- name string - The name of the machine.
- display_name string - The display name of the machine includes cores, memory, and storage.
- operating_system string - The operating system of the machine.
- storage_in_bytes int - How much storage is available to the codespace.
- memory_in_bytes int - How much memory is available to the codespace.
- cpus int - How many cores are available to the codespace.
- prebuild_availability "none"|"ready"|"in_progress" - Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status.
github: NullableCollaborator
Collaborator
Fields
- login string -
- id int -
- email string? -
- name string? -
- node_id string -
- avatar_url string -
- gravatar_id string -
- url string -
- html_url string -
- followers_url string -
- following_url string -
- gists_url string -
- starred_url string -
- subscriptions_url string -
- organizations_url string -
- repos_url string -
- events_url string -
- received_events_url string -
- 'type string -
- site_admin boolean -
- permissions Collaborator_permissions? -
- role_name string -
github: NullableCommunityHealthFile
Fields
- url string -
- html_url string -
github: NullableGitUser
Metaproperties for Git author/committer information.
Fields
- name string? -
- email string? -
- date string? -
github: NullableIntegration
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
Fields
- id int - Unique identifier of the GitHub app
- slug string? - The slug name of the GitHub app
- node_id string -
- owner NullableSimpleUser - A GitHub user.
- name string - The name of the GitHub app
- description string -
- external_url string -
- html_url string -
- created_at string -
- updated_at string -
- permissions Integration_permissions - The set of permissions for the GitHub app
- events string[] - The list of events for the GitHub app
- installations_count int? - The number of installations associated with the GitHub app
- client_id string? -
- client_secret string? -
- webhook_secret string? -
- pem string? -
github: NullableIssue
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
Fields
- id int -
- node_id string -
- url string - URL for the issue
- repository_url string -
- labels_url string -
- comments_url string -
- events_url string -
- html_url string -
- number int - Number uniquely identifying the issue within its repository
- state string - State of the issue; either 'open' or 'closed'
- state_reason "completed"|"reopened"|"not_planned" ? - The reason for the current state
- title string - Title of the issue
- body string? - Contents of the issue
- user NullableSimpleUser - A GitHub user.
- labels (string|record { id int, node_id string, url string, name string, description string?, color string?, default boolean })[] - Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
- assignee NullableSimpleUser - A GitHub user.
- assignees SimpleUser[]? -
- milestone NullableMilestone - A collection of related issues and pull requests.
- locked boolean -
- active_lock_reason string? -
- comments int -
- pull_request Issue_pull_request? -
- closed_at string -
- created_at string -
- updated_at string -
- draft boolean? -
- closed_by NullableSimpleUser? - A GitHub user.
- body_html string? -
- body_text string? -
- timeline_url string? -
- repository Repository? - A repository on GitHub.
- performed_via_github_app NullableIntegration? - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- author_association AuthorAssociation - How the author is associated with the repository.
- reactions ReactionRollup? -
github: NullableLicenseSimple
License Simple
Fields
- 'key string -
- name string -
- url string -
- spdx_id string -
- node_id string -
- html_url string? -
github: NullableMilestone
A collection of related issues and pull requests.
Fields
- url string -
- html_url string -
- labels_url string -
- id int -
- node_id string -
- number int - The number of the milestone.
- state "open"|"closed" - The state of the milestone.
- title string - The title of the milestone.
- description string -
- creator NullableSimpleUser - A GitHub user.
- open_issues int -
- closed_issues int -
- created_at string -
- updated_at string -
- closed_at string -
- due_on string -
github: NullableMinimalRepository
Minimal Repository
Fields
- id int -
- node_id string -
- name string -
- full_name string -
- owner SimpleUser - A GitHub user.
- 'private boolean -
- html_url string -
- description string -
- 'fork boolean -
- url string -
- archive_url string -
- assignees_url string -
- blobs_url string -
- branches_url string -
- collaborators_url string -
- comments_url string -
- commits_url string -
- compare_url string -
- contents_url string -
- contributors_url string -
- deployments_url string -
- downloads_url string -
- events_url string -
- forks_url string -
- git_commits_url string -
- git_refs_url string -
- git_tags_url string -
- git_url string? -
- issue_comment_url string -
- issue_events_url string -
- issues_url string -
- keys_url string -
- labels_url string -
- languages_url string -
- merges_url string -
- milestones_url string -
- notifications_url string -
- pulls_url string -
- releases_url string -
- ssh_url string? -
- stargazers_url string -
- statuses_url string -
- subscribers_url string -
- subscription_url string -
- tags_url string -
- teams_url string -
- trees_url string -
- clone_url string? -
- mirror_url string? -
- hooks_url string -
- svn_url string? -
- homepage string? -
- language string? -
- forks_count int? -
- stargazers_count int? -
- watchers_count int? -
- size int? - The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- default_branch string? -
- open_issues_count int? -
- is_template boolean? -
- topics string[]? -
- has_issues boolean? -
- has_projects boolean? -
- has_wiki boolean? -
- has_pages boolean? -
- has_downloads boolean? -
- has_discussions boolean? -
- archived boolean? -
- disabled boolean? -
- visibility string? -
- pushed_at string? -
- created_at string? -
- updated_at string? -
- permissions Repository_template_repository_permissions? -
- role_name string? -
- temp_clone_token string? -
- delete_branch_on_merge boolean? -
- subscribers_count int? -
- network_count int? -
- code_of_conduct CodeOfConduct? - Code Of Conduct
- license Minimalrepository_license? -
- forks int? -
- open_issues int? -
- watchers int? -
- allow_forking boolean? -
- web_commit_signoff_required boolean? -
- security_and_analysis SecurityAndAnalysis? -
github: NullableRepository
A repository on GitHub.
Fields
- id int - Unique identifier of the repository
- node_id string -
- name string - The name of the repository.
- full_name string -
- license NullableLicenseSimple - License Simple
- organization NullableSimpleUser? - A GitHub user.
- forks int -
- permissions Repository_permissions? -
- owner SimpleUser - A GitHub user.
- 'private boolean - Whether the repository is private or public.
- html_url string -
- description string -
- 'fork boolean -
- url string -
- archive_url string -
- assignees_url string -
- blobs_url string -
- branches_url string -
- collaborators_url string -
- comments_url string -
- commits_url string -
- compare_url string -
- contents_url string -
- contributors_url string -
- deployments_url string -
- downloads_url string -
- events_url string -
- forks_url string -
- git_commits_url string -
- git_refs_url string -
- git_tags_url string -
- git_url string -
- issue_comment_url string -
- issue_events_url string -
- issues_url string -
- keys_url string -
- labels_url string -
- languages_url string -
- merges_url string -
- milestones_url string -
- notifications_url string -
- pulls_url string -
- releases_url string -
- ssh_url string -
- stargazers_url string -
- statuses_url string -
- subscribers_url string -
- subscription_url string -
- tags_url string -
- teams_url string -
- trees_url string -
- clone_url string -
- mirror_url string -
- hooks_url string -
- svn_url string -
- homepage string -
- language string -
- forks_count int -
- stargazers_count int -
- watchers_count int -
- size int - The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- default_branch string - The default branch of the repository.
- open_issues_count int -
- is_template boolean(default false) - Whether this repository acts as a template that can be used to generate new repositories.
- topics string[]? -
- has_issues boolean - Whether issues are enabled.
- has_projects boolean - Whether projects are enabled.
- has_wiki boolean - Whether the wiki is enabled.
- has_pages boolean -
- has_downloads boolean - Whether downloads are enabled.
- has_discussions boolean(default false) - Whether discussions are enabled.
- archived boolean - Whether the repository is archived.
- disabled boolean - Returns whether or not this repository disabled.
- visibility string(default "public") - The repository visibility: public, private, or internal.
- pushed_at string -
- created_at string -
- updated_at string -
- allow_rebase_merge boolean(default true) - Whether to allow rebase merges for pull requests.
- template_repository Repository_template_repository? -
- temp_clone_token string? -
- allow_squash_merge boolean(default true) - Whether to allow squash merges for pull requests.
- allow_auto_merge boolean(default false) - Whether to allow Auto-merge to be used on pull requests.
- delete_branch_on_merge boolean(default false) - Whether to delete head branches when pull requests are merged
- allow_update_branch boolean(default false) - Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- use_squash_pr_title_as_default boolean(default false) - Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use
squash_merge_commit_title
instead.
- squash_merge_commit_title "PR_TITLE"|"COMMIT_OR_PR_TITLE" ? - The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- squash_merge_commit_message "PR_BODY"|"COMMIT_MESSAGES"|"BLANK" ? - The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- merge_commit_title "PR_TITLE"|"MERGE_MESSAGE" ? - The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- merge_commit_message "PR_BODY"|"PR_TITLE"|"BLANK" ? - The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- allow_merge_commit boolean(default true) - Whether to allow merge commits for pull requests.
- allow_forking boolean? - Whether to allow forking this repo
- web_commit_signoff_required boolean(default false) - Whether to require contributors to sign off on web-based commits
- subscribers_count int? -
- network_count int? -
- open_issues int -
- watchers int -
- master_branch string? -
- starred_at string? -
- anonymous_access_enabled boolean? - Whether anonymous git access is enabled for this repository
github: NullableScopedInstallation
Fields
- permissions AppPermissions - The permissions granted to the user access token.
- repository_selection "all"|"selected" - Describe whether all repositories have been selected or there's a selection involved
- single_file_name string -
- has_multiple_single_files boolean? -
- single_file_paths string[]? -
- repositories_url string -
- account SimpleUser - A GitHub user.
github: NullableSimpleCommit
A commit.
Fields
- id string - SHA for the commit
- tree_id string - SHA for the commit's tree
- message string - Message describing the purpose of the commit
- timestamp string - Timestamp of the commit
- author Nullablesimplecommit_author - Information about the Git author
- committer Nullablesimplecommit_committer - Information about the Git committer
github: Nullablesimplecommit_author
Information about the Git author
Fields
- name string - Name of the commit's author
- email string - Git email address of the commit's author
github: Nullablesimplecommit_committer
Information about the Git committer
Fields
- name string - Name of the commit's committer
- email string - Git email address of the commit's committer
github: NullableSimpleUser
A GitHub user.
Fields
- name string? -
- email string? -
- login string -
- id int -
- node_id string -
- avatar_url string -
- gravatar_id string -
- url string -
- html_url string -
- followers_url string -
- following_url string -
- gists_url string -
- starred_url string -
- subscriptions_url string -
- organizations_url string -
- repos_url string -
- events_url string -
- received_events_url string -
- 'type string -
- site_admin boolean -
- starred_at string? -
github: NullableTeamSimple
Groups of organization members that gives permissions on specified repositories.
Fields
- id int - Unique identifier of the team
- node_id string -
- url string - URL for the team
- members_url string -
- name string - Name of the team
- description string - Description of the team
- permission string - Permission that the team will have for its repositories
- privacy string? - The level of privacy this team should have
- notification_setting string? - The notification setting the team has set
- html_url string -
- repositories_url string -
- slug string -
- ldap_dn string? - Distinguished Name (DN) that team maps to within LDAP environment
github: OidcCustomSub
Actions OIDC Subject customization
Fields
- include_claim_keys string[] - Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
github: OidcCustomSubRepo
Actions OIDC subject customization for a repository
Fields
- use_default boolean - Whether to use the default template or not. If
true
, theinclude_claim_keys
field is ignored.
- include_claim_keys string[]? - Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
github: Org_hooks_body
Fields
- name string - Must be passed as "web".
- config Orgsorghooks_config - Key/value pairs to provide settings for this webhook.
- active boolean(default true) - Determines if notifications are sent when the webhook is triggered. Set to
true
to send notifications.
github: Org_invitations_body
Fields
- invitee_id int? - Required unless you provide
email
. GitHub user ID for the person you are inviting.
- email string? - Required unless you provide
invitee_id
. Email address of the person you are inviting, which can be an existing GitHub user.
- role "admin"|"direct_member"|"billing_manager" ? - The role for the new member.
admin
- Organization owners with full administrative rights to the organization and complete access to all repositories and teams.direct_member
- Non-owner organization members with ability to see other members and join teams by invitation.billing_manager
- Non-owner organization members with ability to manage the billing settings of your organization.
- team_ids int[]? - Specify IDs for the teams you want to invite new members to.
github: Org_migrations_body
Fields
- repositories string[] - A list of arrays indicating which repositories should be migrated.
- lock_repositories boolean(default false) - Indicates whether repositories should be locked (to prevent manipulation) while migrating data.
- exclude_metadata boolean(default false) - Indicates whether metadata should be excluded and only git source should be included for the migration.
- exclude_git_data boolean(default false) - Indicates whether the repository git data should be excluded from the migration.
- exclude_attachments boolean(default false) - Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).
- exclude_releases boolean(default false) - Indicates whether releases should be excluded from the migration (to reduce migration archive file size).
- exclude_owner_projects boolean(default false) - Indicates whether projects owned by the organization or users should be excluded. from the migration.
- org_metadata_only boolean(default false) - Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
- exclude ("repositories")[]? - Exclude related items from being returned in the response in order to improve performance of the request.
github: Org_personalaccesstokenrequests_body
Fields
- pat_request_ids int[]? - Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100
pat_request_id
values.
- action "approve"|"deny" - Action to apply to the requests.
- reason string? - Reason for approving or denying the requests. Max 1024 characters.
github: Org_personalaccesstokens_body
Fields
- action "revoke" - Action to apply to the fine-grained personal access token.
- pat_ids int[] - The IDs of the fine-grained personal access tokens.
github: Org_projects_body
Fields
- name string - The name of the project.
- body string? - The description of the project.
github: Org_repos_body
Fields
- name string - The name of the repository.
- description string? - A short description of the repository.
- homepage string? - A URL with more information about the repository.
- 'private boolean(default false) - Whether the repository is private.
- visibility "public"|"private" ? - The visibility of the repository.
- has_issues boolean(default true) - Either
true
to enable issues for this repository orfalse
to disable them.
- has_projects boolean(default true) - Either
true
to enable projects for this repository orfalse
to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default isfalse
, and if you passtrue
, the API returns an error.
- has_wiki boolean(default true) - Either
true
to enable the wiki for this repository orfalse
to disable it.
- has_downloads boolean(default true) - Whether downloads are enabled.
- is_template boolean(default false) - Either
true
to make this repo available as a template repository orfalse
to prevent it.
- team_id int? - The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
- auto_init boolean(default false) - Pass
true
to create an initial commit with empty README.
- gitignore_template string? - Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".
- license_template string? - Choose an open source license template that best suits your needs, and then use the license keyword as the
license_template
string. For example, "mit" or "mpl-2.0".
- allow_squash_merge boolean(default true) - Either
true
to allow squash-merging pull requests, orfalse
to prevent squash-merging.
- allow_merge_commit boolean(default true) - Either
true
to allow merging pull requests with a merge commit, orfalse
to prevent merging pull requests with merge commits.
- allow_rebase_merge boolean(default true) - Either
true
to allow rebase-merging pull requests, orfalse
to prevent rebase-merging.
- allow_auto_merge boolean(default false) - Either
true
to allow auto-merge on pull requests, orfalse
to disallow auto-merge.
- delete_branch_on_merge boolean(default false) - Either
true
to allow automatically deleting head branches when pull requests are merged, orfalse
to prevent automatic deletion. The authenticated user must be an organization owner to set this property totrue
.
- use_squash_pr_title_as_default boolean(default false) - Either
true
to allow squash-merge commits to use pull request title, orfalse
to use commit message. **This property has been deprecated. Please usesquash_merge_commit_title
instead.
- squash_merge_commit_title "PR_TITLE"|"COMMIT_OR_PR_TITLE" ? - The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- squash_merge_commit_message "PR_BODY"|"COMMIT_MESSAGES"|"BLANK" ? - The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- merge_commit_title "PR_TITLE"|"MERGE_MESSAGE" ? - The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- merge_commit_message "PR_BODY"|"PR_TITLE"|"BLANK" ? - The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
github: Org_rulesets_body
Fields
- name string - The name of the ruleset.
- target "branch"|"tag" ? - The target of the ruleset.
- enforcement RepositoryRuleEnforcement - The enforcement level of the ruleset.
evaluate
allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate
is only available with GitHub Enterprise).
- bypass_actors RepositoryRulesetBypassActor[]? - The actors that can bypass the rules in this ruleset
- conditions OrgRulesetConditions? - Conditions for an organization ruleset. The conditions object should contain both
repository_name
andref_name
properties or bothrepository_id
andref_name
properties.
- rules RepositoryRule[]? - An array of rules within the ruleset.
github: Org_teams_body
Fields
- name string - The name of the team.
- description string? - The description of the team.
- maintainers string[]? - List GitHub IDs for organization members who will become team maintainers.
- repo_names string[]? - The full name (e.g., "organization-name/repository-name") of repositories to add the team to.
- privacy "secret"|"closed" ? - The level of privacy this team should have. The options are:
For a non-nested team:secret
- only visible to organization owners and members of this team.closed
- visible to all members of this organization.
Default:secret
For a parent or child team:closed
- visible to all members of this organization.
Default for child team:closed
- notification_setting "notifications_enabled"|"notifications_disabled" ? - The notification setting the team has chosen. The options are:
notifications_enabled
- team members receive notifications when the team is @mentioned.notifications_disabled
- no one receives notifications.
Default:notifications_enabled
- permission "pull"|"push" (default "pull") - Deprecated. The permission that new repositories will be added to the team with when none is specified.
- parent_team_id int? - The ID of a team to set as the parent team.
github: Organization
GitHub account for managing multiple users, teams, and repositories
Fields
- login string - Unique login name of the organization
- url string - URL for the organization
- id int -
- node_id string -
- repos_url string -
- events_url string -
- hooks_url string -
- issues_url string -
- members_url string -
- public_members_url string -
- avatar_url string -
- description string -
- blog string? - Display blog url for the organization
- html_url string -
- name string? - Display name for the organization
- company string? - Display company name for the organization
- location string? - Display location for the organization
- email string? - Display email for the organization
- has_organization_projects boolean - Specifies if organization projects are enabled for this org
- has_repository_projects boolean - Specifies if repository projects are enabled for repositories that belong to this org
- is_verified boolean? -
- public_repos int -
- public_gists int -
- followers int -
- following int -
- 'type string -
- created_at string -
- updated_at string -
- plan Organization_plan? -
github: Organization_plan
Fields
- name string? -
- space int? -
- private_repos int? -
- filled_seats int? -
- seats int? -
github: OrganizationActionsSecret
Secrets for GitHub Actions for an organization.
Fields
- name string - The name of the secret.
- created_at string -
- updated_at string -
- visibility "all"|"private"|"selected" - Visibility of a secret
- selected_repositories_url string? -
github: OrganizationActionsSecretResponse
Secrets for GitHub Actions for an organization.
Fields
- total_count int -
- secrets OrganizationActionsSecret[] -
github: OrganizationActionsVariable
Organization variable for GitHub Actions.
Fields
- name string - The name of the variable.
- value string - The value of the variable.
- created_at string - The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- updated_at string - The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- visibility "all"|"private"|"selected" - Visibility of a variable
- selected_repositories_url string? -
github: OrganizationActionsVariableResponse
Organization variable for GitHub Actions.
Fields
- total_count int -
- variables OrganizationActionsVariable[] -
github: OrganizationDependabotSecret
Secrets for GitHub Dependabot for an organization.
Fields
- name string - The name of the secret.
- created_at string -
- updated_at string -
- visibility "all"|"private"|"selected" - Visibility of a secret
- selected_repositories_url string? -
github: OrganizationDependabotSecretResponse
Secrets for GitHub Dependabot for an organization.
Fields
- total_count int -
- secrets OrganizationDependabotSecret[] -
github: OrganizationFull
Organization Full
Fields
- login string -
- id int -
- node_id string -
- url string -
- repos_url string -
- events_url string -
- hooks_url string -
- issues_url string -
- members_url string -
- public_members_url string -
- avatar_url string -
- description string -
- name string? -
- company string? -
- blog string? -
- location string? -
- email string? -
- twitter_username string? -
- is_verified boolean? -
- has_organization_projects boolean -
- has_repository_projects boolean -
- public_repos int -
- public_gists int -
- followers int -
- following int -
- html_url string -
- 'type string -
- total_private_repos int? -
- owned_private_repos int? -
- private_gists int? -
- disk_usage int? -
- collaborators int? -
- billing_email string? -
- plan Organizationfull_plan? -
- default_repository_permission string? -
- members_can_create_repositories boolean? -
- two_factor_requirement_enabled boolean? -
- members_allowed_repository_creation_type string? -
- members_can_create_public_repositories boolean? -
- members_can_create_private_repositories boolean? -
- members_can_create_internal_repositories boolean? -
- members_can_create_pages boolean? -
- members_can_create_public_pages boolean? -
- members_can_create_private_pages boolean? -
- members_can_fork_private_repositories boolean? -
- web_commit_signoff_required boolean? -
- advanced_security_enabled_for_new_repositories boolean? - Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
- dependabot_alerts_enabled_for_new_repositories boolean? - Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
- dependabot_security_updates_enabled_for_new_repositories boolean? - Whether dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
- dependency_graph_enabled_for_new_repositories boolean? - Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
- secret_scanning_enabled_for_new_repositories boolean? - Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
- secret_scanning_push_protection_enabled_for_new_repositories boolean? - Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
- secret_scanning_push_protection_custom_link_enabled boolean? - Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
- secret_scanning_push_protection_custom_link string? - An optional URL string to display to contributors who are blocked from pushing a secret.
- created_at string -
- updated_at string -
- archived_at string -
github: Organizationfull_plan
Fields
- name string -
- space int -
- private_repos int -
- filled_seats int? -
- seats int? -
github: OrganizationInvitation
Organization Invitation
Fields
- id int -
- login string -
- email string -
- role string -
- created_at string -
- failed_at string? -
- failed_reason string? -
- inviter SimpleUser - A GitHub user.
- team_count int -
- node_id string -
- invitation_teams_url string -
- invitation_source string? -
github: OrganizationProgrammaticAccessGrant
Minimal representation of an organization programmatic access grant for enumerations
Fields
- id int - Unique identifier of the fine-grained personal access token. The
pat_id
used to get details about an approved fine-grained personal access token.
- owner SimpleUser - A GitHub user.
- repository_selection "none"|"all"|"subset" - Type of repository selection requested.
- repositories_url string - URL to the list of repositories the fine-grained personal access token can access. Only follow when
repository_selection
issubset
.
- permissions Organizationprogrammaticaccessgrantrequest_permissions - Permissions requested, categorized by type of permission.
- access_granted_at string - Date and time when the fine-grained personal access token was approved to access the organization.
- token_expired boolean - Whether the associated fine-grained personal access token has expired.
- token_expires_at string - Date and time when the associated fine-grained personal access token expires.
- token_last_used_at string - Date and time when the associated fine-grained personal access token was last used for authentication.
github: OrganizationProgrammaticAccessGrantRequest
Minimal representation of an organization programmatic access grant request for enumerations
Fields
- id int - Unique identifier of the request for access via fine-grained personal access token. The
pat_request_id
used to review PAT requests.
- reason string - Reason for requesting access.
- owner SimpleUser - A GitHub user.
- repository_selection "none"|"all"|"subset" - Type of repository selection requested.
- repositories_url string - URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when
repository_selection
issubset
.
- permissions Organizationprogrammaticaccessgrantrequest_permissions - Permissions requested, categorized by type of permission.
- created_at string - Date and time when the request for access was created.
- token_expired boolean - Whether the associated fine-grained personal access token has expired.
- token_expires_at string - Date and time when the associated fine-grained personal access token expires.
- token_last_used_at string - Date and time when the associated fine-grained personal access token was last used for authentication.
github: Organizationprogrammaticaccessgrantrequest_permissions
Permissions requested, categorized by type of permission.
Fields
- organization record { string... }? -
- repository record { string... }? -
- other record { string... }? -
github: OrganizationSecretScanningAlert
Fields
- number AlertNumber? - The security alert number.
- created_at AlertCreatedAt? - The time that the alert was created in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- updated_at NullableAlertUpdatedAt? - The time that the alert was last updated in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- url AlertUrl? - The REST API URL of the alert resource.
- html_url AlertHtmlUrl? - The GitHub URL of the alert resource.
- locations_url string? - The REST API URL of the code locations for this alert.
- state SecretScanningAlertState? - Sets the state of the secret scanning alert. You must provide
resolution
when you set the state toresolved
.
- resolution SecretScanningAlertResolution? - Required when the
state
isresolved
. The reason for resolving the alert.
- resolved_at string? - The time that the alert was resolved in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- resolved_by NullableSimpleUser? - A GitHub user.
- secret_type string? - The type of secret that secret scanning detected.
- secret_type_display_name string? - User-friendly name for the detected secret, matching the
secret_type
. For a list of built-in patterns, see "Secret scanning patterns."
- secret string? - The secret that was detected.
- repository SimpleRepository? - A GitHub repository.
- push_protection_bypassed boolean? - Whether push protection was bypassed for the detected secret.
- push_protection_bypassed_by NullableSimpleUser? - A GitHub user.
- push_protection_bypassed_at string? - The time that push protection was bypassed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- resolution_comment string? - The comment that was optionally added when this alert was closed
github: OrganizationSimple
A GitHub organization.
Fields
- login string -
- id int -
- node_id string -
- url string -
- repos_url string -
- events_url string -
- hooks_url string -
- issues_url string -
- members_url string -
- public_members_url string -
- avatar_url string -
- description string -
github: OrgHook
Org Hook
Fields
- id int -
- url string -
- ping_url string -
- deliveries_url string? -
- name string -
- events string[] -
- active boolean -
- config Orghook_config -
- updated_at string -
- created_at string -
- 'type string -
github: Orghook_config
Fields
- url string? -
- insecure_ssl string? -
- content_type string? -
- secret string? -
github: OrgMembership
Org Membership
Fields
- url string -
- state "active"|"pending" - The state of the member in the organization. The
pending
state indicates the user has not yet accepted an invitation.
- role "admin"|"member"|"billing_manager" - The user's membership type in the organization.
- organization_url string -
- organization OrganizationSimple - A GitHub organization.
- user NullableSimpleUser - A GitHub user.
- permissions Orgmembership_permissions? -
github: Orgmembership_permissions
Fields
- can_create_repository boolean -
github: Orgs_org_body
Fields
- billing_email string? - Billing email address. This address is not publicized.
- company string? - The company name.
- email string? - The publicly visible email address.
- twitter_username string? - The Twitter username of the company.
- location string? - The location.
- name string? - The shorthand name of the company.
- description string? - The description of the company.
- has_organization_projects boolean? - Whether an organization can use organization projects.
- has_repository_projects boolean? - Whether repositories that belong to the organization can use repository projects.
- default_repository_permission "read"|"write"|"admin"|"none" ? - Default permission level members have for organization repositories.
- members_can_create_repositories boolean? - Whether of non-admin organization members can create repositories. Note: A parameter can override this parameter. See
members_allowed_repository_creation_type
in this table for details.
- members_can_create_internal_repositories boolean? - Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
- members_can_create_private_repositories boolean? - Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
- members_can_create_public_repositories boolean? - Whether organization members can create public repositories, which are visible to anyone. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.
- members_allowed_repository_creation_type "all"|"private"|"none" ? - Specifies which types of repositories non-admin organization members can create.
private
is only available to repositories that are part of an organization on GitHub Enterprise Cloud. Note: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set inmembers_can_create_repositories
. See the parameter deprecation notice in the operation description for details.
- members_can_create_pages boolean? - Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.
- members_can_create_public_pages boolean? - Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.
- members_can_create_private_pages boolean? - Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.
- members_can_fork_private_repositories boolean? - Whether organization members can fork private organization repositories.
- web_commit_signoff_required boolean? - Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.
- blog string? -
- advanced_security_enabled_for_new_repositories boolean? - Whether GitHub Advanced Security is automatically enabled for new repositories.
To use this parameter, 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."
You can check which security and analysis features are currently enabled by using a
GET /orgs/{org}
request.
- dependabot_alerts_enabled_for_new_repositories boolean? - Whether Dependabot alerts is automatically enabled for new repositories.
To use this parameter, 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."
You can check which security and analysis features are currently enabled by using a
GET /orgs/{org}
request.
- dependabot_security_updates_enabled_for_new_repositories boolean? - Whether Dependabot security updates is automatically enabled for new repositories.
To use this parameter, 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."
You can check which security and analysis features are currently enabled by using a
GET /orgs/{org}
request.
- dependency_graph_enabled_for_new_repositories boolean? - Whether dependency graph is automatically enabled for new repositories.
To use this parameter, 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."
You can check which security and analysis features are currently enabled by using a
GET /orgs/{org}
request.
- secret_scanning_enabled_for_new_repositories boolean? - Whether secret scanning is automatically enabled for new repositories.
To use this parameter, 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."
You can check which security and analysis features are currently enabled by using a
GET /orgs/{org}
request.
- secret_scanning_push_protection_enabled_for_new_repositories boolean? - Whether secret scanning push protection is automatically enabled for new repositories.
To use this parameter, 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."
You can check which security and analysis features are currently enabled by using a
GET /orgs/{org}
request.
- secret_scanning_push_protection_custom_link_enabled boolean? - Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
- secret_scanning_push_protection_custom_link string? - If
secret_scanning_push_protection_custom_link_enabled
is true, the URL that will be displayed to contributors who are blocked from pushing a secret.
github: Orgs_org_body_1
Fields
- state "active" - The state that the membership should be in. Only
"active"
will be accepted.
github: Orgsorghooks_config
Key/value pairs to provide settings for this webhook.
Fields
- url WebhookConfigUrl - The URL to which the payloads will be delivered.
- content_type WebhookConfigContentType? - The media type used to serialize the payloads. Supported values include
json
andform
. The default isform
.
- secret WebhookConfigSecret? - If provided, the
secret
will be used as thekey
to generate the HMAC hex digest value for delivery signature headers.
- insecure_ssl WebhookConfigInsecureSsl? -
- username string? -
- password string? -
github: Orgsorghookshook_id_config
Key/value pairs to provide settings for this webhook.
Fields
- url WebhookConfigUrl - The URL to which the payloads will be delivered.
- content_type WebhookConfigContentType? - The media type used to serialize the payloads. Supported values include
json
andform
. The default isform
.
- secret WebhookConfigSecret? - If provided, the
secret
will be used as thekey
to generate the HMAC hex digest value for delivery signature headers.
- insecure_ssl WebhookConfigInsecureSsl? -
github: Outside_collaborators_username_body
Fields
- async boolean? - When set to
true
, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
github: Owner_repo_body
Fields
- permission string? - The permission to grant the team on this repository. We accept the following permissions to be set:
pull
,triage
,push
,maintain
,admin
and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team'spermission
attribute will be used to determine what permission to grant the team on this repository.
github: Owner_repo_body_1
Fields
- name string? - The name of the repository.
- description string? - A short description of the repository.
- homepage string? - A URL with more information about the repository.
- 'private boolean? - Either
true
to make the repository private orfalse
to make it public. Default:false
.
Note: You will get a422
error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.
- visibility "public"|"private" ? - The visibility of the repository.
- security_and_analysis Reposownerrepo_security_and_analysis? - Specify which security and analysis features to enable or disable for the repository.
To use this parameter, 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."
For example, to enable GitHub Advanced Security, use this data in the body of the
PATCH
request:{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }
. You can check which security and analysis features are currently enabled by using aGET /repos/{owner}/{repo}
request.
- has_issues boolean? - Either
true
to enable issues for this repository orfalse
to disable them.
- has_projects boolean? - Either
true
to enable projects for this repository orfalse
to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default isfalse
, and if you passtrue
, the API returns an error.
- has_wiki boolean? - Either
true
to enable the wiki for this repository orfalse
to disable it.
- is_template boolean? - Either
true
to make this repo available as a template repository orfalse
to prevent it.
- default_branch string? - Updates the default branch for this repository.
- allow_squash_merge boolean? - Either
true
to allow squash-merging pull requests, orfalse
to prevent squash-merging.
- allow_merge_commit boolean? - Either
true
to allow merging pull requests with a merge commit, orfalse
to prevent merging pull requests with merge commits.
- allow_rebase_merge boolean? - Either
true
to allow rebase-merging pull requests, orfalse
to prevent rebase-merging.
- allow_auto_merge boolean? - Either
true
to allow auto-merge on pull requests, orfalse
to disallow auto-merge.
- delete_branch_on_merge boolean? - Either
true
to allow automatically deleting head branches when pull requests are merged, orfalse
to prevent automatic deletion.
- allow_update_branch boolean? - Either
true
to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.
- use_squash_pr_title_as_default boolean? - Either
true
to allow squash-merge commits to use pull request title, orfalse
to use commit message. **This property has been deprecated. Please usesquash_merge_commit_title
instead.
- squash_merge_commit_title "PR_TITLE"|"COMMIT_OR_PR_TITLE" ? - The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- squash_merge_commit_message "PR_BODY"|"COMMIT_MESSAGES"|"BLANK" ? - The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- merge_commit_title "PR_TITLE"|"MERGE_MESSAGE" ? - The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- merge_commit_message "PR_BODY"|"PR_TITLE"|"BLANK" ? - The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- archived boolean? - Whether to archive this repository.
false
will unarchive a previously archived repository.
- allow_forking boolean? - Either
true
to allow private forks, orfalse
to prevent private forks.
- web_commit_signoff_required boolean? - Either
true
to require contributors to sign off on web-based commits, orfalse
to not require contributors to sign off on web-based commits.
github: Owner_repo_body_2
Fields
- permission "pull"|"push"|"admin" ? - The permission to grant the team on this repository. If no permission is specified, the team's
permission
attribute will be used to determine what permission to grant the team on this repository.
github: Package
A software package
Fields
- id int - Unique identifier of the package.
- name string - The name of the package.
- package_type "npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" -
- url string -
- html_url string -
- version_count int - The number of versions of the package.
- visibility "private"|"public" -
- owner NullableSimpleUser? - A GitHub user.
- repository NullableMinimalRepository? - Minimal Repository
- created_at string -
- updated_at string -
github: PackagesBillingUsage
Fields
- total_gigabytes_bandwidth_used int - Sum of the free and paid storage space (GB) for GitHuub Packages.
- total_paid_gigabytes_bandwidth_used int - Total paid storage space (GB) for GitHuub Packages.
- included_gigabytes_bandwidth int - Free storage space (GB) for GitHub Packages.
github: PackageVersion
A version of a software package
Fields
- id int - Unique identifier of the package version.
- name string - The name of the package version.
- url string -
- package_html_url string -
- html_url string? -
- license string? -
- description string? -
- created_at string -
- updated_at string -
- deleted_at string? -
- metadata PackageVersionMetadata? -
github: PackageVersionMetadata
Fields
- package_type "npm"|"maven"|"rubygems"|"docker"|"nuget"|"container" -
- container ContainerMetadata? -
- docker DockerMetadata? -
github: Page
The configuration for GitHub Pages for a repository.
Fields
- url string - The API address for accessing this Page resource.
- status "built"|"building"|"errored" - The status of the most recent build of the Page.
- cname string - The Pages site's custom domain
- protected_domain_state "pending"|"verified"|"unverified" ? - The state if the domain is verified
- pending_domain_unverified_at string? - The timestamp when a pending domain becomes unverified.
- custom_404 boolean - Whether the Page has a custom 404 page.
- html_url string? - The web address the Page can be accessed from.
- build_type "legacy"|"workflow" ? - The process in which the Page will be built.
- 'source PagesSourceHash? -
- 'public boolean - Whether the GitHub Pages site is publicly visible. If set to
true
, the site is accessible to anyone on the internet. If set tofalse
, the site will only be accessible to users who have at leastread
access to the repository that published the site.
- https_certificate PagesHttpsCertificate? -
- https_enforced boolean? - Whether https is enabled on the domain
github: PageBuild
Page Build
Fields
- url string -
- status string -
- 'error Pagebuild_error -
- pusher NullableSimpleUser - A GitHub user.
- 'commit string -
- duration int -
- created_at string -
- updated_at string -
github: Pagebuild_error
Fields
- message string -
github: PageBuildStatus
Page Build Status
Fields
- url string -
- status string -
github: PageDeployment
The GitHub Pages deployment status.
Fields
- status_url string - The URI to monitor GitHub Pages deployment status.
- page_url string - The URI to the deployed GitHub Pages.
- preview_url string? - The URI to the deployed GitHub Pages preview.
github: Pages_deployment_body
The object used to create GitHub Pages deployment
Fields
- artifact_url string - The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.
- environment string(default "github-pages") - The target environment for this GitHub Pages deployment.
- pages_build_version string - A unique string that represents the version of the build for this deployment.
- oidc_token string - The OIDC token issued by GitHub Actions certifying the origin of the deployment.
github: PagesHealthCheck
Pages Health Check Status
Fields
- domain Pageshealthcheck_domain? -
- alt_domain Pageshealthcheck_alt_domain? -
github: Pageshealthcheck_alt_domain
Fields
- host string? -
- uri string? -
- nameservers string? -
- dns_resolves boolean? -
- is_proxied boolean? -
- is_cloudflare_ip boolean? -
- is_fastly_ip boolean? -
- is_old_ip_address boolean? -
- is_a_record boolean? -
- has_cname_record boolean? -
- has_mx_records_present boolean? -
- is_valid_domain boolean? -
- is_apex_domain boolean? -
- should_be_a_record boolean? -
- is_cname_to_github_user_domain boolean? -
- is_cname_to_pages_dot_github_dot_com boolean? -
- is_cname_to_fastly boolean? -
- is_pointed_to_github_pages_ip boolean? -
- is_non_github_pages_ip_present boolean? -
- is_pages_domain boolean? -
- is_served_by_pages boolean? -
- is_valid boolean? -
- reason string? -
- responds_to_https boolean? -
- enforces_https boolean? -
- https_error string? -
- is_https_eligible boolean? -
- caa_error string? -
github: Pageshealthcheck_domain
Fields
- host string? -
- uri string? -
- nameservers string? -
- dns_resolves boolean? -
- is_proxied boolean? -
- is_cloudflare_ip boolean? -
- is_fastly_ip boolean? -
- is_old_ip_address boolean? -
- is_a_record boolean? -
- has_cname_record boolean? -
- has_mx_records_present boolean? -
- is_valid_domain boolean? -
- is_apex_domain boolean? -
- should_be_a_record boolean? -
- is_cname_to_github_user_domain boolean? -
- is_cname_to_pages_dot_github_dot_com boolean? -
- is_cname_to_fastly boolean? -
- is_pointed_to_github_pages_ip boolean? -
- is_non_github_pages_ip_present boolean? -
- is_pages_domain boolean? -
- is_served_by_pages boolean? -
- is_valid boolean? -
- reason string? -
- responds_to_https boolean? -
- enforces_https boolean? -
- https_error string? -
- is_https_eligible boolean? -
- caa_error string? -
github: PagesHttpsCertificate
Fields
- state "new"|"authorization_created"|"authorization_pending"|"authorized"|"authorization_revoked"|"issued"|"uploaded"|"approved"|"errored"|"bad_authz"|"destroy_pending"|"dns_changed" -
- description string -
- domains string[] - Array of the domain set and its alternate name (if it is configured)
- expires_at string? -
github: PagesSourceHash
Fields
- branch string -
- path string -
github: ParticipationStats
Fields
- all int[] -
- owner int[] -
github: PendingDeployment
Details of a deployment that is waiting for protection rules to pass
Fields
- environment Pendingdeployment_environment -
- wait_timer int - The set duration of the wait timer
- wait_timer_started_at string - The time that the wait timer began.
- current_user_can_approve boolean - Whether the currently authenticated user can approve the deployment
- reviewers Pendingdeployment_reviewers[] - The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
github: Pendingdeployment_environment
Fields
- id int? - The id of the environment.
- node_id string? -
- name string? - The name of the environment.
- url string? -
- html_url string? -
github: Pendingdeployment_reviewers
Fields
- 'type DeploymentReviewerType? - The type of reviewer.
- reviewer SimpleUser|Team? -
github: Permissions_repositories_body
Fields
- selected_repository_ids int[] - List of repository IDs to enable for GitHub Actions.
github: PersonalAccessTokenRequest
Details of a Personal Access Token Request.
Fields
- id int - Unique identifier of the request for access via fine-grained personal access token. Used as the
pat_request_id
parameter in the list and review API calls.
- owner SimpleUser - A GitHub user.
- permissions_added Personalaccesstokenrequest_permissions_added - New requested permissions, categorized by type of permission.
- permissions_upgraded Personalaccesstokenrequest_permissions_upgraded - Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
- permissions_result Personalaccesstokenrequest_permissions_result - Permissions requested, categorized by type of permission. This field incorporates
permissions_added
andpermissions_upgraded
.
- repository_selection "none"|"all"|"subset" - Type of repository selection requested.
- repository_count int - The number of repositories the token is requesting access to. This field is only populated when
repository_selection
issubset
.
- repositories Personalaccesstokenrequest_repositories[] - An array of repository objects the token is requesting access to. This field is only populated when
repository_selection
issubset
.
- created_at string - Date and time when the request for access was created.
- token_expired boolean - Whether the associated fine-grained personal access token has expired.
- token_expires_at string - Date and time when the associated fine-grained personal access token expires.
- token_last_used_at string - Date and time when the associated fine-grained personal access token was last used for authentication.
github: Personalaccesstokenrequest_permissions_added
New requested permissions, categorized by type of permission.
Fields
- organization record { string... }? -
- repository record { string... }? -
- other record { string... }? -
github: Personalaccesstokenrequest_permissions_result
Permissions requested, categorized by type of permission. This field incorporates permissions_added
and permissions_upgraded
.
Fields
- organization record { string... }? -
- repository record { string... }? -
- other record { string... }? -
github: Personalaccesstokenrequest_permissions_upgraded
Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
Fields
- organization record { string... }? -
- repository record { string... }? -
- other record { string... }? -
github: Personalaccesstokenrequest_repositories
Fields
- full_name string -
- id int - Unique identifier of the repository
- name string - The name of the repository.
- node_id string -
- 'private boolean - Whether the repository is private or public.
github: Personalaccesstokenrequests_pat_request_id_body
Fields
- action "approve"|"deny" - Action to apply to the request.
- reason string? - Reason for approving or denying the request. Max 1024 characters.
github: Personalaccesstokens_pat_id_body
Fields
- action "revoke" - Action to apply to the fine-grained personal access token.
github: PorterAuthor
Porter Author
Fields
- id int -
- remote_id string -
- remote_name string -
- email string -
- name string -
- url string -
- import_url string -
github: PorterLargeFile
Porter Large File
Fields
- ref_name string -
- path string -
- oid string -
- size int -
github: PrivateUser
Private User
Fields
- login string -
- id int -
- node_id string -
- avatar_url string -
- gravatar_id string -
- url string -
- html_url string -
- followers_url string -
- following_url string -
- gists_url string -
- starred_url string -
- subscriptions_url string -
- organizations_url string -
- repos_url string -
- events_url string -
- received_events_url string -
- 'type string -
- site_admin boolean -
- name string -
- company string -
- blog string -
- location string -
- email string -
- hireable boolean -
- bio string -
- twitter_username string? -
- public_repos int -
- public_gists int -
- followers int -
- following int -
- created_at string -
- updated_at string -
- private_gists int -
- total_private_repos int -
- owned_private_repos int -
- disk_usage int -
- collaborators int -
- two_factor_authentication boolean -
- plan Publicuser_plan? -
- suspended_at string? -
- business_plus boolean? -
- ldap_dn string? -
github: PrivateVulnerabilityReportCreate
Fields
- summary string - A short summary of the advisory.
- description string - A detailed description of what the advisory impacts.
- vulnerabilities Repositoryadvisorycreate_vulnerabilities[]? - An array of products affected by the vulnerability detailed in a repository security advisory.
- cwe_ids string[]? - A list of Common Weakness Enumeration (CWE) IDs.
- severity "critical"|"high"|"medium"|"low" ? - The severity of the advisory. You must choose between setting this field or
cvss_vector_string
.
- cvss_vector_string string? - The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or
severity
.
github: Project
Projects are a way to organize columns and cards of work.
Fields
- owner_url string -
- url string -
- html_url string -
- columns_url string -
- id int -
- node_id string -
- name string - Name of the project
- body string - Body of the project
- number int -
- state string - State of the project; either 'open' or 'closed'
- creator NullableSimpleUser - A GitHub user.
- created_at string -
- updated_at string -
- organization_permission "read"|"write"|"admin"|"none" ? - The baseline permission that all organization members have on this project. Only present if owner is an organization.
- 'private boolean? - Whether or not this project can be seen by everyone. Only present if owner is an organization.
github: Project_id_columns_body
Fields
- name string - Name of the project column
github: ProjectCard
Project cards represent a scope of work.
Fields
- url string -
- id int - The project card's ID
- node_id string -
- note string -
- creator NullableSimpleUser - A GitHub user.
- created_at string -
- updated_at string -
- archived boolean? - Whether or not the card is archived
- column_name string? -
- project_id string? -
- column_url string -
- content_url string? -
- project_url string -
github: ProjectCollaboratorPermission
Project Collaborator Permission
Fields
- permission string -
- user NullableSimpleUser - A GitHub user.
github: ProjectColumn
Project columns contain cards of work.
Fields
- url string -
- project_url string -
- cards_url string -
- id int - The unique identifier of the project column
- node_id string -
- name string - Name of the project column
- created_at string -
- updated_at string -
github: Projects_project_id_body
Fields
- permission "read"|"write"|"admin" ? - The permission to grant to the team for this project. Default: the team's
permission
attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to setContent-Length
to zero when calling this endpoint. For more information, see "HTTP verbs."
github: Projects_project_id_body_1
Fields
- name string? - Name of the project
- body string? - Body of the project
- state string? - State of the project; either 'open' or 'closed'
- organization_permission "read"|"write"|"admin"|"none" ? - The baseline permission that all organization members have on this project
- 'private boolean? - Whether or not this project can be seen by everyone.
github: Projects_project_id_body_2
Fields
- permission "read"|"write"|"admin" ? - The permission to grant to the team for this project. Default: the team's
permission
attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to setContent-Length
to zero when calling this endpoint. For more information, see "HTTP verbs."
github: ProjectsV2
A projects v2 project
Fields
- id decimal -
- node_id string -
- owner SimpleUser - A GitHub user.
- creator SimpleUser - A GitHub user.
- title string -
- description string -
- 'public boolean -
- closed_at string -
- created_at string -
- updated_at string -
- number int -
- short_description string -
- deleted_at string -
- deleted_by NullableSimpleUser - A GitHub user.
github: ProjectsV2Item
An item belonging to a project
Fields
- id decimal -
- node_id string? -
- project_node_id string? -
- content_node_id string -
- content_type ProjectsV2ItemContentType - The type of content tracked in a project item
- creator SimpleUser? - A GitHub user.
- created_at string -
- updated_at string -
- archived_at string -
github: ProtectedBranch
Branch protections protect branches
Fields
- url string -
- required_status_checks StatusCheckPolicy? - Status Check Policy
- required_pull_request_reviews Protectedbranch_required_pull_request_reviews? -
- required_signatures Branchprotection_required_signatures? -
- enforce_admins Protectedbranch_enforce_admins? -
- required_linear_history Protectedbranch_required_linear_history? -
- allow_force_pushes Protectedbranch_required_linear_history? -
- allow_deletions Protectedbranch_required_linear_history? -
- restrictions BranchRestrictionPolicy? - Branch Restriction Policy
- required_conversation_resolution Protectedbranch_required_conversation_resolution? -
- block_creations Protectedbranch_required_linear_history? -
- lock_branch Protectedbranch_lock_branch? - Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
- allow_fork_syncing Protectedbranch_allow_fork_syncing? - Whether users can pull changes from upstream when the branch is locked. Set to
true
to allow fork syncing. Set tofalse
to prevent fork syncing.
github: Protectedbranch_allow_fork_syncing
Whether users can pull changes from upstream when the branch is locked. Set to true
to allow fork syncing. Set to false
to prevent fork syncing.
Fields
- enabled boolean? -
github: Protectedbranch_enforce_admins
Fields
- url string -
- enabled boolean -
github: Protectedbranch_lock_branch
Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
Fields
- enabled boolean? -
github: Protectedbranch_required_conversation_resolution
Fields
- enabled boolean? -
github: Protectedbranch_required_linear_history
Fields
- enabled boolean -
github: Protectedbranch_required_pull_request_reviews
Fields
- url string -
- dismiss_stale_reviews boolean? -
- require_code_owner_reviews boolean? -
- required_approving_review_count int? -
- require_last_push_approval boolean(default false) - Whether the most recent push must be approved by someone other than the person who pushed it.
- dismissal_restrictions Protectedbranch_required_pull_request_reviews_dismissal_restrictions? -
- bypass_pull_request_allowances Protectedbranch_required_pull_request_reviews_bypass_pull_request_allowances? -
github: Protectedbranch_required_pull_request_reviews_bypass_pull_request_allowances
Fields
- users SimpleUser[] -
- teams Team[] -
- apps Integration[]? -
github: Protectedbranch_required_pull_request_reviews_dismissal_restrictions
Fields
- url string -
- users_url string -
- teams_url string -
- users SimpleUser[] -
- teams Team[] -
- apps Integration[]? -
github: ProtectedBranchAdminEnforced
Protected Branch Admin Enforced
Fields
- url string -
- enabled boolean -
github: ProtectedBranchPullRequestReview
Protected Branch Pull Request Review
Fields
- url string? -
- dismissal_restrictions Protectedbranchpullrequestreview_dismissal_restrictions? -
- bypass_pull_request_allowances Protectedbranchpullrequestreview_bypass_pull_request_allowances? - Allow specific users, teams, or apps to bypass pull request requirements.
- dismiss_stale_reviews boolean -
- require_code_owner_reviews boolean -
- required_approving_review_count int? -
- require_last_push_approval boolean(default false) - Whether the most recent push must be approved by someone other than the person who pushed it.
github: Protectedbranchpullrequestreview_bypass_pull_request_allowances
Allow specific users, teams, or apps to bypass pull request requirements.
Fields
- users SimpleUser[]? - The list of users allowed to bypass pull request requirements.
- teams Team[]? - The list of teams allowed to bypass pull request requirements.
- apps Integration[]? - The list of apps allowed to bypass pull request requirements.
github: Protectedbranchpullrequestreview_dismissal_restrictions
Fields
- users SimpleUser[]? - The list of users with review dismissal access.
- teams Team[]? - The list of teams with review dismissal access.
- apps Integration[]? - The list of apps with review dismissal access.
- url string? -
- users_url string? -
- teams_url string? -
github: ProtectedBranchRequiredStatusCheck
Protected Branch Required Status Check
Fields
- url string? -
- enforcement_level string? -
- contexts string[] -
- checks Protectedbranchrequiredstatuscheck_checks[] -
- contexts_url string? -
- strict boolean? -
github: Protectedbranchrequiredstatuscheck_checks
Fields
- context string -
- app_id int -
github: Protection_required_pull_request_reviews_body
Fields
- dismissal_restrictions Reposownerrepobranchesbranchprotection_required_pull_request_reviews_dismissal_restrictions? - Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty
dismissal_restrictions
object to disable. User and teamdismissal_restrictions
are only available for organization-owned repositories. Omit this parameter for personal repositories.
- dismiss_stale_reviews boolean? - Set to
true
if you want to automatically dismiss approving reviews when someone pushes a new commit.
- require_code_owner_reviews boolean? - Blocks merging pull requests until code owners have reviewed.
- required_approving_review_count int? - Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.
- require_last_push_approval boolean? - Whether the most recent push must be approved by someone other than the person who pushed it. Default:
false
- bypass_pull_request_allowances Reposownerrepobranchesbranchprotection_required_pull_request_reviews_bypass_pull_request_allowances? - Allow specific users, teams, or apps to bypass pull request requirements.
github: Protection_required_status_checks_body
Fields
- strict boolean? - Require branches to be up to date before merging.
- contexts string[]? - Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use
checks
instead ofcontexts
for more fine-grained control.
- checks Reposownerrepobranchesbranchprotection_required_status_checks_checks[]? - The list of status checks to require in order to merge into this branch.
github: ProxyConfig
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
github: PublicUser
Public User
Fields
- login string -
- id int -
- node_id string -
- avatar_url string -
- gravatar_id string -
- url string -
- html_url string -
- followers_url string -
- following_url string -
- gists_url string -
- starred_url string -
- subscriptions_url string -
- organizations_url string -
- repos_url string -
- events_url string -
- received_events_url string -
- 'type string -
- site_admin boolean -
- name string -
- company string -
- blog string -
- location string -
- email string -
- hireable boolean -
- bio string -
- twitter_username string? -
- public_repos int -
- public_gists int -
- followers int -
- following int -
- created_at string -
- updated_at string -
- plan Publicuser_plan? -
- suspended_at string? -
- private_gists int? -
- total_private_repos int? -
- owned_private_repos int? -
- disk_usage int? -
- collaborators int? -
github: Publicuser_plan
Fields
- collaborators int -
- name string -
- space int -
- private_repos int -
github: Pull_number_codespaces_body
Fields
- location string? - The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.
- geo "EuropeWest"|"SoutheastAsia"|"UsEast"|"UsWest" ? - The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces
location
, which is being deprecated.
- client_ip string? - IP for location auto-detection when proxying a request
- machine string? - Machine type to use for this codespace
- devcontainer_path string? - Path to devcontainer.json config to use for this codespace
- multi_repo_permissions_opt_out boolean? - Whether to authorize requested permissions from devcontainer.json
- working_directory string? - Working directory for this codespace
- idle_timeout_minutes int? - Time in minutes before codespace stops from inactivity
- display_name string? - Display name for this codespace
- retention_period_minutes int? - Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
github: Pull_number_comments_body
Fields
- body string - The text of the review comment.
- commit_id string - The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the
position
.
- path string - The relative path to the file that necessitates a comment.
- position int? - This parameter is deprecated. Use
line
instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.
- side "LEFT"|"RIGHT" ? - In a split diff view, the side of the diff that the pull request's changes appear on. Can be
LEFT
orRIGHT
. UseLEFT
for deletions that appear in red. UseRIGHT
for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.
- line int? - Required unless using
subject_type:file
. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.
- start_line int? - Required when using multi-line comments unless using
in_reply_to
. Thestart_line
is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.
- start_side "LEFT"|"RIGHT"|"side" ? - Required when using multi-line comments unless using
in_reply_to
. Thestart_side
is the starting side of the diff that the comment applies to. Can beLEFT
orRIGHT
. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. Seeside
in this table for additional context.
- in_reply_to int? - The ID of the review comment to reply to. To find the ID of a review comment with "List review comments on a pull request". When specified, all parameters other than
body
in the request body are ignored.
- subject_type "line"|"file" ? - The level at which the comment is targeted.
github: Pull_number_merge_body
Fields
- commit_title string? - Title for the automatic commit message.
- commit_message string? - Extra detail to append to automatic commit message.
- sha string? - SHA that pull request head must match to allow merge.
- merge_method "merge"|"squash"|"rebase" ? - The merge method to use.
github: Pull_number_requested_reviewers_body_1
Fields
- reviewers string[] - An array of user
login
s that will be removed.
- team_reviewers string[]? - An array of team
slug
s that will be removed.
github: Pull_number_reviews_body
Fields
- commit_id string? - The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the
position
. Defaults to the most recent commit in the pull request when you do not specify a value.
- body string? - Required when using
REQUEST_CHANGES
orCOMMENT
for theevent
parameter. The body text of the pull request review.
- event "APPROVE"|"REQUEST_CHANGES"|"COMMENT" ? - The review action you want to perform. The review actions include:
APPROVE
,REQUEST_CHANGES
, orCOMMENT
. By leaving this blank, you set the review action state toPENDING
, which means you will need to submit the pull request review when you are ready.
- comments Reposownerrepopullspull_numberreviews_comments[]? - Use the following table to specify the location, destination, and contents of the draft review comment.
github: Pull_number_updatebranch_body
Fields
- expected_head_sha string? - The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a
422 Unprocessable Entity
status. You can use the "List commits" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.
github: PullRequest
Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.
Fields
- url string -
- id int -
- node_id string -
- html_url string -
- diff_url string -
- patch_url string -
- issue_url string -
- commits_url string -
- review_comments_url string -
- review_comment_url string -
- comments_url string -
- statuses_url string -
- number int - Number uniquely identifying the pull request within its repository.
- state "open"|"closed" - State of this Pull Request. Either
open
orclosed
.
- locked boolean -
- title string - The title of the pull request.
- user SimpleUser - A GitHub user.
- body string -
- labels Pullrequest_labels[] -
- milestone NullableMilestone - A collection of related issues and pull requests.
- active_lock_reason string? -
- created_at string -
- updated_at string -
- closed_at string -
- merged_at string -
- merge_commit_sha string -
- assignee NullableSimpleUser - A GitHub user.
- assignees SimpleUser[]? -
- requested_reviewers SimpleUser[]? -
- requested_teams TeamSimple[]? -
- head Pullrequest_head -
- base Pullrequest_base -
- _links Pullrequestsimple__links -
- author_association AuthorAssociation - How the author is associated with the repository.
- auto_merge AutoMerge - The status of auto merging a pull request.
- draft boolean? - Indicates whether or not the pull request is a draft.
- merged boolean -
- mergeable boolean -
- rebaseable boolean? -
- mergeable_state string -
- merged_by NullableSimpleUser - A GitHub user.
- comments int -
- review_comments int -
- maintainer_can_modify boolean - Indicates whether maintainers can modify the pull request.
- commits int -
- additions int -
- deletions int -
- changed_files int -
github: Pullrequest_base
Fields
- label string -
- ref string -
- repo Pullrequest_base_repo -
- sha string -
- user Pullrequest_head_repo_owner -
github: Pullrequest_base_repo
Fields
- archive_url string -
- assignees_url string -
- blobs_url string -
- branches_url string -
- collaborators_url string -
- comments_url string -
- commits_url string -
- compare_url string -
- contents_url string -
- contributors_url string -
- deployments_url string -
- description string -
- downloads_url string -
- events_url string -
- 'fork boolean -
- forks_url string -
- full_name string -
- git_commits_url string -
- git_refs_url string -
- git_tags_url string -
- hooks_url string -
- html_url string -
- id int -
- is_template boolean? -
- node_id string -
- issue_comment_url string -
- issue_events_url string -
- issues_url string -
- keys_url string -
- labels_url string -
- languages_url string -
- merges_url string -
- milestones_url string -
- name string -
- notifications_url string -
- owner Pullrequest_head_repo_owner -
- 'private boolean -
- pulls_url string -
- releases_url string -
- stargazers_url string -
- statuses_url string -
- subscribers_url string -
- subscription_url string -
- tags_url string -
- teams_url string -
- trees_url string -
- url string -
- clone_url string -
- default_branch string -
- forks int -
- forks_count int -
- git_url string -
- has_downloads boolean -
- has_issues boolean -
- has_projects boolean -
- has_wiki boolean -
- has_pages boolean -
- has_discussions boolean -
- homepage string -
- language string -
- master_branch string? -
- archived boolean -
- disabled boolean -
- visibility string? - The repository visibility: public, private, or internal.
- mirror_url string -
- open_issues int -
- open_issues_count int -
- permissions Fullrepository_permissions? -
- temp_clone_token string? -
- allow_merge_commit boolean? -
- allow_squash_merge boolean? -
- allow_rebase_merge boolean? -
- license NullableLicenseSimple - License Simple
- pushed_at string -
- size int -
- ssh_url string -
- stargazers_count int -
- svn_url string -
- topics string[]? -
- watchers int -
- watchers_count int -
- created_at string -
- updated_at string -
- allow_forking boolean? -
- web_commit_signoff_required boolean? -
github: Pullrequest_head
Fields
- label string -
- ref string -
- repo Pullrequest_head_repo -
- sha string -
- user Pullrequest_head_repo_owner -
github: Pullrequest_head_repo
Fields
- archive_url string -
- assignees_url string -
- blobs_url string -
- branches_url string -
- collaborators_url string -
- comments_url string -
- commits_url string -
- compare_url string -
- contents_url string -
- contributors_url string -
- deployments_url string -
- description string -
- downloads_url string -
- events_url string -
- 'fork boolean -
- forks_url string -
- full_name string -
- git_commits_url string -
- git_refs_url string -
- git_tags_url string -
- hooks_url string -
- html_url string -
- id int -
- node_id string -
- issue_comment_url string -
- issue_events_url string -
- issues_url string -
- keys_url string -
- labels_url string -
- languages_url string -
- merges_url string -
- milestones_url string -
- name string -
- notifications_url string -
- owner Pullrequest_head_repo_owner -
- 'private boolean -
- pulls_url string -
- releases_url string -
- stargazers_url string -
- statuses_url string -
- subscribers_url string -
- subscription_url string -
- tags_url string -
- teams_url string -
- trees_url string -
- url string -
- clone_url string -
- default_branch string -
- forks int -
- forks_count int -
- git_url string -
- has_downloads boolean -
- has_issues boolean -
- has_projects boolean -
- has_wiki boolean -
- has_pages boolean -
- has_discussions boolean -
- homepage string -
- language string -
- master_branch string? -
- archived boolean -
- disabled boolean -
- visibility string? - The repository visibility: public, private, or internal.
- mirror_url string -
- open_issues int -
- open_issues_count int -
- permissions Fullrepository_permissions? -
- temp_clone_token string? -
- allow_merge_commit boolean? -
- allow_squash_merge boolean? -
- allow_rebase_merge boolean? -
- license Pullrequest_head_repo_license -
- pushed_at string -
- size int -
- ssh_url string -
- stargazers_count int -
- svn_url string -
- topics string[]? -
- watchers int -
- watchers_count int -
- created_at string -
- updated_at string -
- allow_forking boolean? -
- is_template boolean? -
- web_commit_signoff_required boolean? -
github: Pullrequest_head_repo_license
Fields
- 'key string -
- name string -
- url string -
- spdx_id string -
- node_id string -
github: Pullrequest_head_repo_owner
Fields
- avatar_url string -
- events_url string -
- followers_url string -
- following_url string -
- gists_url string -
- gravatar_id string -
- html_url string -
- id int -
- node_id string -
- login string -
- organizations_url string -
- received_events_url string -
- repos_url string -
- site_admin boolean -
- starred_url string -
- subscriptions_url string -
- 'type string -
- url string -
github: Pullrequest_labels
Fields
- id int -
- node_id string -
- url string -
- name string -
- description string -
- color string -
- default boolean -
github: PullRequestMergeResult
Pull Request Merge Result
Fields
- sha string -
- merged boolean -
- message string -
github: PullRequestMinimal
Fields
- id int -
- number int -
- url string -
- head Pullrequestminimal_head -
- base Pullrequestminimal_head -
github: Pullrequestminimal_head
Fields
- ref string -
- sha string -
- repo Pullrequestminimal_head_repo -
github: Pullrequestminimal_head_repo
Fields
- id int -
- url string -
- name string -
github: PullRequestReview
Pull Request Reviews are reviews on pull requests.
Fields
- id int - Unique identifier of the review
- node_id string -
- user NullableSimpleUser - A GitHub user.
- body string - The text of the review.
- state string -
- html_url string -
- pull_request_url string -
- _links Timelinereviewedevent__links -
- submitted_at string? -
- commit_id string - A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be
null
.
- body_html string? -
- body_text string? -
- author_association AuthorAssociation - How the author is associated with the repository.
github: PullRequestReviewComment
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
Fields
- url string - URL for the pull request review comment
- pull_request_review_id int - The ID of the pull request review to which the comment belongs.
- id int - The ID of the pull request review comment.
- node_id string - The node ID of the pull request review comment.
- diff_hunk string - The diff of the line that the comment refers to.
- path string - The relative path of the file to which the comment applies.
- position int? - The line index in the diff to which the comment applies. This field is deprecated; use
line
instead.
- original_position int? - The index of the original line in the diff to which the comment applies. This field is deprecated; use
original_line
instead.
- commit_id string - The SHA of the commit to which the comment applies.
- original_commit_id string - The SHA of the original commit to which the comment applies.
- in_reply_to_id int? - The comment ID to reply to.
- user SimpleUser - A GitHub user.
- body string - The text of the comment.
- created_at string -
- updated_at string -
- html_url string - HTML URL for the pull request review comment.
- pull_request_url string - URL for the pull request that the review comment belongs to.
- author_association AuthorAssociation - How the author is associated with the repository.
- _links Pullrequestreviewcomment__links -
- start_line int? - The first line of the range for a multi-line comment.
- original_start_line int? - The first line of the range for a multi-line comment.
- start_side "LEFT"|"RIGHT" (default "RIGHT") - The side of the first line of the range for a multi-line comment.
- line int? - The line of the blob to which the comment applies. The last line of the range for a multi-line comment
- original_line int? - The line of the blob to which the comment applies. The last line of the range for a multi-line comment
- side "LEFT"|"RIGHT" (default "RIGHT") - The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment
- subject_type "line"|"file" ? - The level at which the comment is targeted, can be a diff line or a file.
- reactions ReactionRollup? -
- body_html string? -
- body_text string? -
github: Pullrequestreviewcomment__links
Fields
- pull_request Pullrequestreviewcomment__links_pull_request -
github: Pullrequestreviewcomment__links_html
Fields
- href string -
github: Pullrequestreviewcomment__links_pull_request
Fields
- href string -
github: Pullrequestreviewcomment__links_self
Fields
- href string -
github: PullRequestReviewRequest
Pull Request Review Request
Fields
- users SimpleUser[] -
- teams Team[] -
github: PullRequestSimple
Pull Request Simple
Fields
- url string -
- id int -
- node_id string -
- html_url string -
- diff_url string -
- patch_url string -
- issue_url string -
- commits_url string -
- review_comments_url string -
- review_comment_url string -
- comments_url string -
- statuses_url string -
- number int -
- state string -
- locked boolean -
- title string -
- user NullableSimpleUser - A GitHub user.
- body string -
- labels Pullrequestsimple_labels[] -
- milestone NullableMilestone - A collection of related issues and pull requests.
- active_lock_reason string? -
- created_at string -
- updated_at string -
- closed_at string -
- merged_at string -
- merge_commit_sha string -
- assignee NullableSimpleUser - A GitHub user.
- assignees SimpleUser[]? -
- requested_reviewers SimpleUser[]? -
- requested_teams Team[]? -
- head Pullrequestsimple_head -
- base Pullrequestsimple_head -
- _links Pullrequestsimple__links -
- author_association AuthorAssociation - How the author is associated with the repository.
- auto_merge AutoMerge - The status of auto merging a pull request.
- draft boolean? - Indicates whether or not the pull request is a draft.
github: Pullrequestsimple__links
Fields
- comments Link - Hypermedia Link
- commits Link - Hypermedia Link
- statuses Link - Hypermedia Link
- html Link - Hypermedia Link
- issue Link - Hypermedia Link
- review_comments Link - Hypermedia Link
- review_comment Link - Hypermedia Link
- self Link - Hypermedia Link
github: Pullrequestsimple_head
Fields
- label string -
- ref string -
- repo Repository - A repository on GitHub.
- sha string -
- user NullableSimpleUser - A GitHub user.
github: Pullrequestsimple_labels
Fields
- id int -
- node_id string -
- url string -
- name string -
- description string -
- color string -
- default boolean -
github: Pulls_pull_number_body
Fields
- title string? - The title of the pull request.
- body string? - The contents of the pull request.
- state "open"|"closed" ? - State of this Pull Request. Either
open
orclosed
.
- base string? - The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.
- maintainer_can_modify boolean? - Indicates whether maintainers can modify the pull request.
github: RateLimit
Fields
- 'limit int -
- remaining int -
- reset int -
- used int -
github: RateLimitOverview
Rate Limit Overview
Fields
- resources Ratelimitoverview_resources -
- rate RateLimit -
github: Ratelimitoverview_resources
Fields
- core RateLimit -
- graphql RateLimit? -
- search RateLimit -
- code_search RateLimit? -
- source_import RateLimit? -
- integration_manifest RateLimit? -
- code_scanning_upload RateLimit? -
- actions_runner_registration RateLimit? -
- scim RateLimit? -
- dependency_snapshots RateLimit? -
github: Reaction
Reactions to conversations provide a way to help people express their feelings more simply and effectively.
Fields
- id int -
- node_id string -
- user NullableSimpleUser - A GitHub user.
- content "+1"|"-1"|"laugh"|"confused"|"heart"|"hooray"|"rocket"|"eyes" - The reaction to use
- created_at string -
github: ReactionRollup
Fields
- url string -
- total_count int -
- \+1 int -
- \-1 int -
- laugh int -
- confused int -
- heart int -
- hooray int -
- eyes int -
- rocket int -
github: Reactions
Fields
- \+1 int -
- \-1 int -
- confused int -
- eyes int -
- heart int -
- hooray int -
- laugh int -
- rocket int -
- total_count int -
- url string -
github: ReferencedWorkflow
A workflow referenced/reused by the initial caller workflow
Fields
- path string -
- sha string -
- ref string? -
github: ReferrerTraffic
Referrer Traffic
Fields
- referrer string -
- count int -
- uniques int -
github: Refs_ref_body
Fields
- sha string - The SHA1 value to set this reference to
- force boolean(default false) - Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to
false
will make sure you're not overwriting work.
github: Release
A release.
Fields
- url string -
- html_url string -
- assets_url string -
- upload_url string -
- tarball_url string -
- zipball_url string -
- id int -
- node_id string -
- tag_name string - The name of the tag.
- target_commitish string - Specifies the commitish value that determines where the Git tag is created from.
- name string -
- body string? -
- draft boolean - true to create a draft (unpublished) release, false to create a published one.
- prerelease boolean - Whether to identify the release as a prerelease or a full release.
- created_at string -
- published_at string -
- author SimpleUser - A GitHub user.
- assets ReleaseAsset[] -
- body_html string? -
- body_text string? -
- mentions_count int? -
- discussion_url string? - The URL of the release discussion.
- reactions ReactionRollup? -
github: Release_id_reactions_body
Fields
- content "+1"|"laugh"|"heart"|"hooray"|"rocket"|"eyes" - The reaction type to add to the release.
github: ReleaseAsset
Data related to a release.
Fields
- url string -
- browser_download_url string -
- id int -
- node_id string -
- name string - The file name of the asset.
- label string -
- state "uploaded"|"open" - State of the release asset.
- content_type string -
- size int -
- download_count int -
- created_at string -
- updated_at string -
- uploader NullableSimpleUser - A GitHub user.
github: ReleaseNotesContent
Generated name and body describing a release
Fields
- name string - The generated name of the release
- body string - The generated body describing the contents of the release supporting markdown formatting
github: Releases_generatenotes_body
Fields
- tag_name string - The tag name for the release. This can be an existing tag or a new one.
- target_commitish string? - Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.
- previous_tag_name string? - The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.
- configuration_file_path string? - Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.
github: Releases_release_id_body
Fields
- tag_name string? - The name of the tag.
- target_commitish string? - Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
- name string? - The name of the release.
- body string? - Text describing the contents of the tag.
- draft boolean? -
true
makes the release a draft, andfalse
publishes the release.
- prerelease boolean? -
true
to identify the release as a prerelease,false
to identify the release as a full release.
- make_latest "true"|"false"|"legacy" ? - Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to
true
for newly published releases.legacy
specifies that the latest release should be determined based on the release creation date and higher semantic version.
- discussion_category_name string? - If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "Managing categories for discussions in your repository."
github: RemovedFromProjectIssueEvent
Removed from Project Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- project_card Addedtoprojectissueevent_project_card? -
github: RenamedIssueEvent
Renamed Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- rename Renamedissueevent_rename -
github: Renamedissueevent_rename
Fields
- 'from string -
- to string -
github: Repo_autolinks_body
Fields
- key_prefix string - This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.
- url_template string - The URL must contain
<num>
for the reference number.<num>
matches different characters depending on the value ofis_alphanumeric
.
- is_alphanumeric boolean(default true) - Whether this autolink reference matches alphanumeric characters. If true, the
<num>
parameter of theurl_template
matches alphanumeric charactersA-Z
(case insensitive),0-9
, and-
. If false, this autolink reference only matches numeric characters.
github: Repo_checksuites_body
Fields
- head_sha string - The sha of the head commit.
github: Repo_codespaces_body
Fields
- ref string? - Git ref (typically a branch name) for this codespace
- location string? - The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.
- geo "EuropeWest"|"SoutheastAsia"|"UsEast"|"UsWest" ? - The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces
location
, which is being deprecated.
- client_ip string? - IP for location auto-detection when proxying a request
- machine string? - Machine type to use for this codespace
- devcontainer_path string? - Path to devcontainer.json config to use for this codespace
- multi_repo_permissions_opt_out boolean? - Whether to authorize requested permissions from devcontainer.json
- working_directory string? - Working directory for this codespace
- idle_timeout_minutes int? - Time in minutes before codespace stops from inactivity
- display_name string? - Display name for this codespace
- retention_period_minutes int? - Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
github: Repo_deployments_body
Fields
- ref string - The ref to deploy. This can be a branch, tag, or SHA.
- task string(default "deploy") - Specifies a task to execute (e.g.,
deploy
ordeploy:migrations
).
- auto_merge boolean(default true) - Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
- payload record {}|string? -
- environment string(default "production") - Name for the target deployment environment (e.g.,
production
,staging
,qa
).
- description string?(default "") - Short description of the deployment.
- transient_environment boolean(default false) - Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default:
false
- production_environment boolean? - Specifies if the given environment is one that end-users directly interact with. Default:
true
whenenvironment
isproduction
andfalse
otherwise.
github: Repo_dispatches_body
Fields
- event_type string - A custom webhook event name. Must be 100 characters or fewer.
- client_payload record {}? - JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.
github: Repo_forks_body
Fields
- organization string? - Optional parameter to specify the organization name if forking into an organization.
- name string? - When forking from an existing repository, a new name for the fork.
- default_branch_only boolean? - When forking from an existing repository, fork with only the default branch.
github: Repo_hooks_body
Fields
- name string? - Use
web
to create a webhook. Default:web
. This parameter only accepts the valueweb
.
- config Reposownerrepohooks_config? - Key/value pairs to provide settings for this webhook.
- active boolean? - Determines if notifications are sent when the webhook is triggered. Set to
true
to send notifications.
github: Repo_import_body
Fields
- vcs_url string - The URL of the originating repository.
- vcs "subversion"|"git"|"mercurial"|"tfvc" ? - The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.
- vcs_username string? - If authentication is required, the username to provide to
vcs_url
.
- vcs_password string? - If authentication is required, the password to provide to
vcs_url
.
- tfvc_project string? - For a tfvc import, the name of the project that is being imported.
github: Repo_import_body_1
Fields
- vcs_username string? - The username to provide to the originating repository.
- vcs_password string? - The password to provide to the originating repository.
- vcs "subversion"|"tfvc"|"git"|"mercurial" ? - The type of version control system you are migrating from.
- tfvc_project string? - For a tfvc import, the name of the project that is being imported.
github: Repo_issues_body
Fields
- body string? - The contents of the issue.
- assignee string? - Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.
- assignees string[]? - Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.
github: Repo_keys_body
Fields
- title string? - A name for the key.
- 'key string - The contents of the key.
- read_only boolean? - If
true
, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "Repository permission levels for an organization" and "Permission levels for a user account repository."
github: Repo_labels_body
Fields
- name string - The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing
:strawberry:
will render the emoji . For a full list of available emoji and codes, see "Emoji cheat sheet."
- color string? - The hexadecimal color code for the label, without the leading
#
.
- description string? - A short description of the label. Must be 100 characters or fewer.
github: Repo_merges_body
Fields
- base string - The name of the base branch that the head will be merged into.
- head string - The head to merge. This can be a branch name or a commit SHA1.
- commit_message string? - Commit message to use for the merge commit. If omitted, a default message will be used.
github: Repo_mergeupstream_body
Fields
- branch string - The name of the branch which should be updated to match upstream.
github: Repo_milestones_body
Fields
- title string - The title of the milestone.
- state "open"|"closed" (default "open") - The state of the milestone. Either
open
orclosed
.
- description string? - A description of the milestone.
github: Repo_notifications_body
Fields
- last_read_at string? - Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
. Default: The current timestamp.
github: Repo_projects_body
Fields
- name string - The name of the project.
- body string? - The description of the project.
github: Repo_pulls_body
Fields
- title string? - The title of the new pull request. Required unless
issue
is specified.
- head string - The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace
head
with a user like this:username:branch
.
- head_repo string? - The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.
- base string - The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.
- body string? - The contents of the pull request.
- maintainer_can_modify boolean? - Indicates whether maintainers can modify the pull request.
- draft boolean? - Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.
- issue int? - An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless
title
is specified.
github: Repo_releases_body
Fields
- tag_name string - The name of the tag.
- target_commitish string? - Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
- name string? - The name of the release.
- body string? - Text describing the contents of the tag.
- draft boolean(default false) -
true
to create a draft (unpublished) release,false
to create a published one.
- prerelease boolean(default false) -
true
to identify the release as a prerelease.false
to identify the release as a full release.
- discussion_category_name string? - If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "Managing categories for discussions in your repository."
- generate_release_notes boolean(default false) - Whether to automatically generate the name and body for this release. If
name
is specified, the specified name will be used; otherwise, a name will be automatically generated. Ifbody
is specified, the body will be pre-pended to the automatically generated notes.
- make_latest "true"|"false"|"legacy" (default "true") - Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to
true
for newly published releases.legacy
specifies that the latest release should be determined based on the release creation date and higher semantic version.
github: Repo_rulesets_body
Fields
- name string - The name of the ruleset.
- target "branch"|"tag" ? - The target of the ruleset.
- enforcement RepositoryRuleEnforcement - The enforcement level of the ruleset.
evaluate
allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate
is only available with GitHub Enterprise).
- bypass_actors RepositoryRulesetBypassActor[]? - The actors that can bypass the rules in this ruleset
- conditions RepositoryRulesetConditions? - Parameters for a repository ruleset ref name condition
- rules RepositoryRule[]? - An array of rules within the ruleset.
github: Repo_subscription_body
Fields
- subscribed boolean? - Determines if notifications should be received from this repository.
- ignored boolean? - Determines if all notifications should be blocked from this repository.
github: Repo_topics_body
Fields
- names string[] - An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array (
[]
) to clear all topics from the repository. Note: Topicnames
cannot contain uppercase letters.
github: Repo_transfer_body
Fields
- new_owner string - The username or organization name the repository will be transferred to.
- new_name string? - The new name to be given to the repository.
- team_ids int[]? - ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
github: RepoCodespacesSecret
Set repository secrets for GitHub Codespaces.
Fields
- name string - The name of the secret.
- created_at string -
- updated_at string -
github: RepoCodespacesSecretResponse
Set repository secrets for GitHub Codespaces.
Fields
- total_count int -
- secrets RepoCodespacesSecret[] -
github: RepoSearchResultItem
Repo Search Result Item
Fields
- id int -
- node_id string -
- name string -
- full_name string -
- owner NullableSimpleUser - A GitHub user.
- 'private boolean -
- html_url string -
- description string -
- 'fork boolean -
- url string -
- created_at string -
- updated_at string -
- pushed_at string -
- homepage string -
- size int -
- stargazers_count int -
- watchers_count int -
- language string -
- forks_count int -
- open_issues_count int -
- master_branch string? -
- default_branch string -
- score decimal -
- forks_url string -
- keys_url string -
- collaborators_url string -
- teams_url string -
- hooks_url string -
- issue_events_url string -
- events_url string -
- assignees_url string -
- branches_url string -
- tags_url string -
- blobs_url string -
- git_tags_url string -
- git_refs_url string -
- trees_url string -
- statuses_url string -
- languages_url string -
- stargazers_url string -
- contributors_url string -
- subscribers_url string -
- subscription_url string -
- commits_url string -
- git_commits_url string -
- comments_url string -
- issue_comment_url string -
- contents_url string -
- compare_url string -
- merges_url string -
- archive_url string -
- downloads_url string -
- issues_url string -
- pulls_url string -
- milestones_url string -
- notifications_url string -
- labels_url string -
- releases_url string -
- deployments_url string -
- git_url string -
- ssh_url string -
- clone_url string -
- svn_url string -
- forks int -
- open_issues int -
- watchers int -
- topics string[]? -
- mirror_url string -
- has_issues boolean -
- has_projects boolean -
- has_pages boolean -
- has_wiki boolean -
- has_downloads boolean -
- has_discussions boolean? -
- archived boolean -
- disabled boolean - Returns whether or not this repository disabled.
- visibility string? - The repository visibility: public, private, or internal.
- license NullableLicenseSimple - License Simple
- permissions Fullrepository_permissions? -
- text_matches SearchResultTextMatches? -
- temp_clone_token string? -
- allow_merge_commit boolean? -
- allow_squash_merge boolean? -
- allow_rebase_merge boolean? -
- allow_auto_merge boolean? -
- delete_branch_on_merge boolean? -
- allow_forking boolean? -
- is_template boolean? -
- web_commit_signoff_required boolean? -
github: RepoSearchResultItemResponse
Repo Search Result Item
Fields
- total_count int -
- incomplete_results boolean -
- items RepoSearchResultItem[] -
github: Repository
A repository on GitHub.
Fields
- id int - Unique identifier of the repository
- node_id string -
- name string - The name of the repository.
- full_name string -
- license NullableLicenseSimple - License Simple
- organization NullableSimpleUser? - A GitHub user.
- forks int -
- permissions Repository_permissions? -
- owner SimpleUser - A GitHub user.
- 'private boolean - Whether the repository is private or public.
- html_url string -
- description string -
- 'fork boolean -
- url string -
- archive_url string -
- assignees_url string -
- blobs_url string -
- branches_url string -
- collaborators_url string -
- comments_url string -
- commits_url string -
- compare_url string -
- contents_url string -
- contributors_url string -
- deployments_url string -
- downloads_url string -
- events_url string -
- forks_url string -
- git_commits_url string -
- git_refs_url string -
- git_tags_url string -
- git_url string -
- issue_comment_url string -
- issue_events_url string -
- issues_url string -
- keys_url string -
- labels_url string -
- languages_url string -
- merges_url string -
- milestones_url string -
- notifications_url string -
- pulls_url string -
- releases_url string -
- ssh_url string -
- stargazers_url string -
- statuses_url string -
- subscribers_url string -
- subscription_url string -
- tags_url string -
- teams_url string -
- trees_url string -
- clone_url string -
- mirror_url string -
- hooks_url string -
- svn_url string -
- homepage string -
- language string -
- forks_count int -
- stargazers_count int -
- watchers_count int -
- size int - The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- default_branch string - The default branch of the repository.
- open_issues_count int -
- is_template boolean(default false) - Whether this repository acts as a template that can be used to generate new repositories.
- topics string[]? -
- has_issues boolean - Whether issues are enabled.
- has_projects boolean - Whether projects are enabled.
- has_wiki boolean - Whether the wiki is enabled.
- has_pages boolean -
- has_downloads boolean - Whether downloads are enabled.
- has_discussions boolean(default false) - Whether discussions are enabled.
- archived boolean - Whether the repository is archived.
- disabled boolean - Returns whether or not this repository disabled.
- visibility string(default "public") - The repository visibility: public, private, or internal.
- pushed_at string -
- created_at string -
- updated_at string -
- allow_rebase_merge boolean(default true) - Whether to allow rebase merges for pull requests.
- template_repository Repository_template_repository? -
- temp_clone_token string? -
- allow_squash_merge boolean(default true) - Whether to allow squash merges for pull requests.
- allow_auto_merge boolean(default false) - Whether to allow Auto-merge to be used on pull requests.
- delete_branch_on_merge boolean(default false) - Whether to delete head branches when pull requests are merged
- allow_update_branch boolean(default false) - Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- use_squash_pr_title_as_default boolean(default false) - Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use
squash_merge_commit_title
instead.
- squash_merge_commit_title "PR_TITLE"|"COMMIT_OR_PR_TITLE" ? - The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- squash_merge_commit_message "PR_BODY"|"COMMIT_MESSAGES"|"BLANK" ? - The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- merge_commit_title "PR_TITLE"|"MERGE_MESSAGE" ? - The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- merge_commit_message "PR_BODY"|"PR_TITLE"|"BLANK" ? - The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- allow_merge_commit boolean(default true) - Whether to allow merge commits for pull requests.
- allow_forking boolean? - Whether to allow forking this repo
- web_commit_signoff_required boolean(default false) - Whether to require contributors to sign off on web-based commits
- subscribers_count int? -
- network_count int? -
- open_issues int -
- watchers int -
- master_branch string? -
- starred_at string? -
- anonymous_access_enabled boolean? - Whether anonymous git access is enabled for this repository
github: Repository_permissions
Fields
- admin boolean -
- pull boolean -
- triage boolean? -
- push boolean -
- maintain boolean? -
github: Repository_template_repository
Fields
- id int? -
- node_id string? -
- name string? -
- full_name string? -
- owner Repository_template_repository_owner? -
- 'private boolean? -
- html_url string? -
- description string? -
- 'fork boolean? -
- url string? -
- archive_url string? -
- assignees_url string? -
- blobs_url string? -
- branches_url string? -
- collaborators_url string? -
- comments_url string? -
- commits_url string? -
- compare_url string? -
- contents_url string? -
- contributors_url string? -
- deployments_url string? -
- downloads_url string? -
- events_url string? -
- forks_url string? -
- git_commits_url string? -
- git_refs_url string? -
- git_tags_url string? -
- git_url string? -
- issue_comment_url string? -
- issue_events_url string? -
- issues_url string? -
- keys_url string? -
- labels_url string? -
- languages_url string? -
- merges_url string? -
- milestones_url string? -
- notifications_url string? -
- pulls_url string? -
- releases_url string? -
- ssh_url string? -
- stargazers_url string? -
- statuses_url string? -
- subscribers_url string? -
- subscription_url string? -
- tags_url string? -
- teams_url string? -
- trees_url string? -
- clone_url string? -
- mirror_url string? -
- hooks_url string? -
- svn_url string? -
- homepage string? -
- language string? -
- forks_count int? -
- stargazers_count int? -
- watchers_count int? -
- size int? -
- default_branch string? -
- open_issues_count int? -
- is_template boolean? -
- topics string[]? -
- has_issues boolean? -
- has_projects boolean? -
- has_wiki boolean? -
- has_pages boolean? -
- has_downloads boolean? -
- archived boolean? -
- disabled boolean? -
- visibility string? -
- pushed_at string? -
- created_at string? -
- updated_at string? -
- permissions Repository_template_repository_permissions? -
- allow_rebase_merge boolean? -
- temp_clone_token string? -
- allow_squash_merge boolean? -
- allow_auto_merge boolean? -
- delete_branch_on_merge boolean? -
- allow_update_branch boolean? -
- use_squash_pr_title_as_default boolean? -
- squash_merge_commit_title "PR_TITLE"|"COMMIT_OR_PR_TITLE" ? - The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- squash_merge_commit_message "PR_BODY"|"COMMIT_MESSAGES"|"BLANK" ? - The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- merge_commit_title "PR_TITLE"|"MERGE_MESSAGE" ? - The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- merge_commit_message "PR_BODY"|"PR_TITLE"|"BLANK" ? - The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- allow_merge_commit boolean? -
- subscribers_count int? -
- network_count int? -
github: Repository_template_repository_owner
Fields
- login string? -
- id int? -
- node_id string? -
- avatar_url string? -
- gravatar_id string? -
- url string? -
- html_url string? -
- followers_url string? -
- following_url string? -
- gists_url string? -
- starred_url string? -
- subscriptions_url string? -
- organizations_url string? -
- repos_url string? -
- events_url string? -
- received_events_url string? -
- 'type string? -
- site_admin boolean? -
github: Repository_template_repository_permissions
Fields
- admin boolean? -
- maintain boolean? -
- push boolean? -
- triage boolean? -
- pull boolean? -
github: RepositoryAdvisory
A repository security advisory.
Fields
- ghsa_id string - The GitHub Security Advisory ID.
- cve_id string - The Common Vulnerabilities and Exposures (CVE) ID.
- url string - The API URL for the advisory.
- html_url string - The URL for the advisory.
- summary string - A short summary of the advisory.
- description string - A detailed description of what the advisory entails.
- severity "critical"|"high"|"medium"|"low" - The severity of the advisory.
- author SimpleUser - The author of the advisory.
- publisher SimpleUser - The publisher of the advisory.
- identifiers Globaladvisory_identifiers[] -
- state "published"|"closed"|"withdrawn"|"draft"|"triage" - The state of the advisory.
- created_at string - The date and time of when the advisory was created, in ISO 8601 format.
- updated_at string - The date and time of when the advisory was last updated, in ISO 8601 format.
- published_at string - The date and time of when the advisory was published, in ISO 8601 format.
- closed_at string - The date and time of when the advisory was closed, in ISO 8601 format.
- withdrawn_at string - The date and time of when the advisory was withdrawn, in ISO 8601 format.
- submission Repositoryadvisory_submission -
- vulnerabilities RepositoryAdvisoryVulnerability[] -
- cvss Globaladvisory_cvss -
- cwes Globaladvisory_cwes[] -
- cwe_ids string[] - A list of only the CWE IDs.
- credits Repositoryadvisory_credits[] -
- credits_detailed RepositoryAdvisoryCredit[] -
- collaborating_users SimpleUser[] - A list of users that collaborate on the advisory.
- collaborating_teams Team[] - A list of teams that collaborate on the advisory.
- private_fork SimpleRepository - A temporary private fork of the advisory's repository for collaborating on a fix.
github: Repositoryadvisory_credits
Fields
- login string? - The username of the user credited.
- 'type SecurityAdvisoryCreditTypes? - The type of credit the user is receiving.
github: Repositoryadvisory_submission
Fields
- accepted boolean - Whether a private vulnerability report was accepted by the repository's administrators.
github: RepositoryAdvisoryCreate
Fields
- summary string - A short summary of the advisory.
- description string - A detailed description of what the advisory impacts.
- cve_id string? - The Common Vulnerabilities and Exposures (CVE) ID.
- vulnerabilities Repositoryadvisorycreate_vulnerabilities[] - A product affected by the vulnerability detailed in a repository security advisory.
- cwe_ids string[]? - A list of Common Weakness Enumeration (CWE) IDs.
- credits Repositoryadvisorycreate_credits[]? - A list of users receiving credit for their participation in the security advisory.
- severity "critical"|"high"|"medium"|"low" ? - The severity of the advisory. You must choose between setting this field or
cvss_vector_string
.
- cvss_vector_string string? - The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or
severity
.
github: Repositoryadvisorycreate_credits
Fields
- login string - The username of the user credited.
- 'type SecurityAdvisoryCreditTypes - The type of credit the user is receiving.
github: Repositoryadvisorycreate_package
The name of the package affected by the vulnerability.
Fields
- ecosystem SecurityAdvisoryEcosystems - The package's language or package management ecosystem.
- name string? - The unique package name within its ecosystem.
github: Repositoryadvisorycreate_vulnerabilities
Fields
- package Repositoryadvisorycreate_package - The name of the package affected by the vulnerability.
- vulnerable_version_range string? - The range of the package versions affected by the vulnerability.
- patched_versions string? - The package version(s) that resolve the vulnerability.
- vulnerable_functions string[]? - The functions in the package that are affected.
github: RepositoryAdvisoryCredit
A credit given to a user for a repository security advisory.
Fields
- user SimpleUser - A GitHub user.
- 'type SecurityAdvisoryCreditTypes - The type of credit the user is receiving.
- state "accepted"|"declined"|"pending" - The state of the user's acceptance of the credit.
github: RepositoryAdvisoryUpdate
Fields
- summary string? - A short summary of the advisory.
- description string? - A detailed description of what the advisory impacts.
- cve_id string? - The Common Vulnerabilities and Exposures (CVE) ID.
- vulnerabilities Repositoryadvisorycreate_vulnerabilities[]? - A product affected by the vulnerability detailed in a repository security advisory.
- cwe_ids string[]? - A list of Common Weakness Enumeration (CWE) IDs.
- credits Repositoryadvisorycreate_credits[]? - A list of users receiving credit for their participation in the security advisory.
- severity "critical"|"high"|"medium"|"low" ? - The severity of the advisory. You must choose between setting this field or
cvss_vector_string
.
- cvss_vector_string string? - The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or
severity
.
- state "published"|"closed"|"draft" ? - The state of the advisory.
- collaborating_users string[]? - A list of usernames who have been granted write access to the advisory.
- collaborating_teams string[]? - A list of team slugs which have been granted write access to the advisory.
github: RepositoryAdvisoryVulnerability
A product affected by the vulnerability detailed in a repository security advisory.
Fields
- package Globaladvisory_package - The name of the package affected by the vulnerability.
- vulnerable_version_range string - The range of the package versions affected by the vulnerability.
- patched_versions string - The package version(s) that resolve the vulnerability.
- vulnerable_functions string[] - The functions in the package that are affected.
github: RepositoryCollaboratorPermission
Repository Collaborator Permission
Fields
- permission string -
- role_name string -
- user NullableCollaborator - Collaborator
github: RepositoryInvitation
Repository invitations let you manage who you collaborate with.
Fields
- id int - Unique identifier of the repository invitation.
- repository MinimalRepository - Minimal Repository
- invitee NullableSimpleUser - A GitHub user.
- inviter NullableSimpleUser - A GitHub user.
- permissions "read"|"write"|"admin"|"triage"|"maintain" - The permission associated with the invitation.
- created_at string -
- expired boolean? - Whether or not the invitation has expired
- url string - URL for the repository invitation
- html_url string -
- node_id string -
github: RepositoryResponse
A repository on GitHub.
Fields
- total_count int -
- repository_selection string? -
- repositories Repository[] -
github: RepositoryRuleBranchNamePattern
Parameters to be used for the branch_name_pattern rule
Fields
- 'type "branch_name_pattern" -
- parameters Repositoryrulecommitmessagepattern_parameters? -
github: RepositoryRuleCommitAuthorEmailPattern
Parameters to be used for the commit_author_email_pattern rule
Fields
- 'type "commit_author_email_pattern" -
- parameters Repositoryrulecommitmessagepattern_parameters? -
github: RepositoryRuleCommitMessagePattern
Parameters to be used for the commit_message_pattern rule
Fields
- 'type "commit_message_pattern" -
- parameters Repositoryrulecommitmessagepattern_parameters? -
github: Repositoryrulecommitmessagepattern_parameters
Fields
- name string? - How this rule will appear to users.
- negate boolean? - If true, the rule will fail if the pattern matches.
- operator "starts_with"|"ends_with"|"contains"|"regex" - The operator to use for matching.
- pattern string - The pattern to match with.
github: RepositoryRuleCommitterEmailPattern
Parameters to be used for the committer_email_pattern rule
Fields
- 'type "committer_email_pattern" -
- parameters Repositoryrulecommitmessagepattern_parameters? -
github: RepositoryRuleCreation
Only allow users with bypass permission to create matching refs.
Fields
- 'type "creation" -
github: RepositoryRuleDeletion
Only allow users with bypass permissions to delete matching refs.
Fields
- 'type "deletion" -
github: RepositoryRuleNonFastForward
Prevent users with push access from force pushing to refs.
Fields
- 'type "non_fast_forward" -
github: RepositoryRuleParamsStatusCheckConfiguration
Required status check
Fields
- context string - The status check context name that must be present on the commit.
- integration_id int? - The optional integration ID that this status check must originate from.
github: RepositoryRulePullRequest
Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
Fields
- 'type "pull_request" -
- parameters Repositoryrulepullrequest_parameters? -
github: Repositoryrulepullrequest_parameters
Fields
- dismiss_stale_reviews_on_push boolean - New, reviewable commits pushed will dismiss previous pull request review approvals.
- require_code_owner_review boolean - Require an approving review in pull requests that modify files that have a designated code owner.
- require_last_push_approval boolean - Whether the most recent reviewable push must be approved by someone other than the person who pushed it.
- required_approving_review_count int - The number of approving reviews that are required before a pull request can be merged.
- required_review_thread_resolution boolean - All conversations on code must be resolved before a pull request can be merged.
github: RepositoryRuleRequiredDeployments
Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.
Fields
- 'type "required_deployments" -
- parameters Repositoryrulerequireddeployments_parameters? -
github: Repositoryrulerequireddeployments_parameters
Fields
- required_deployment_environments string[] - The environments that must be successfully deployed to before branches can be merged.
github: RepositoryRuleRequiredLinearHistory
Prevent merge commits from being pushed to matching refs.
Fields
- 'type "required_linear_history" -
github: RepositoryRuleRequiredSignatures
Commits pushed to matching refs must have verified signatures.
Fields
- 'type "required_signatures" -
github: RepositoryRuleRequiredStatusChecks
Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.
Fields
- 'type "required_status_checks" -
- parameters Repositoryrulerequiredstatuschecks_parameters? -
github: Repositoryrulerequiredstatuschecks_parameters
Fields
- required_status_checks RepositoryRuleParamsStatusCheckConfiguration[] - Status checks that are required.
- strict_required_status_checks_policy boolean - Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled.
github: RepositoryRuleRulesetInfo
User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
Fields
- ruleset_source_type "Repository"|"Organization" ? - The type of source for the ruleset that includes this rule.
- ruleset_source string? - The name of the source of the ruleset that includes this rule.
- ruleset_id int? - The ID of the ruleset that includes this rule.
github: RepositoryRuleset
A set of rules to apply when specified conditions are met.
Fields
- id int - The ID of the ruleset
- name string - The name of the ruleset
- target "branch"|"tag" ? - The target of the ruleset
- source_type "Repository"|"Organization" ? - The type of the source of the ruleset
- 'source string - The name of the source
- enforcement RepositoryRuleEnforcement - The enforcement level of the ruleset.
evaluate
allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate
is only available with GitHub Enterprise).
- bypass_actors RepositoryRulesetBypassActor[]? - The actors that can bypass the rules in this ruleset
- current_user_can_bypass "always"|"pull_requests_only"|"never" ? - The bypass type of the user making the API request for this ruleset. This field is only returned when querying the repository-level endpoint.
- node_id string? -
- _links Repositoryruleset__links? -
- conditions RepositoryRulesetConditions|OrgRulesetConditions? -
- rules RepositoryRule[]? -
- created_at string? -
- updated_at string? -
github: Repositoryruleset__links
Fields
- self Repositoryruleset__links_self? -
- html Repositoryruleset__links_html? -
github: Repositoryruleset__links_html
Fields
- href string? - The html URL of the ruleset
github: Repositoryruleset__links_self
Fields
- href string? - The URL of the ruleset
github: RepositoryRulesetBypassActor
An actor that can bypass rules in a ruleset
Fields
- actor_id int - The ID of the actor that can bypass a ruleset. If
actor_type
isOrganizationAdmin
, this should be1
.
- actor_type "RepositoryRole"|"Team"|"Integration"|"OrganizationAdmin" - The type of actor that can bypass a ruleset
- bypass_mode "always"|"pull_request" - When the specified actor can bypass the ruleset.
pull_request
means that an actor can only bypass rules on pull requests.
github: RepositoryRulesetConditions
Parameters for a repository ruleset ref name condition
Fields
- ref_name Repositoryrulesetconditions_ref_name? -
github: Repositoryrulesetconditions_ref_name
Fields
- include string[]? - Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts
~DEFAULT_BRANCH
to include the default branch or~ALL
to include all branches.
- exclude string[]? - Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.
github: RepositoryRulesetConditionsRepositoryIdTarget
Parameters for a repository ID condition
Fields
- repository_id Repositoryrulesetconditionsrepositoryidtarget_repository_id -
github: Repositoryrulesetconditionsrepositoryidtarget_repository_id
Fields
- repository_ids int[]? - The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.
github: RepositoryRulesetConditionsRepositoryNameTarget
Parameters for a repository name condition
Fields
- repository_name Repositoryrulesetconditionsrepositorynametarget_repository_name -
github: Repositoryrulesetconditionsrepositorynametarget_repository_name
Fields
- include string[]? - Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts
~ALL
to include all repositories.
- exclude string[]? - Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
- protected boolean? - Whether renaming of target repositories is prevented.
github: RepositoryRuleTagNamePattern
Parameters to be used for the tag_name_pattern rule
Fields
- 'type "tag_name_pattern" -
- parameters Repositoryrulecommitmessagepattern_parameters? -
github: RepositoryRuleUpdate
Only allow users with bypass permission to update matching refs.
Fields
- 'type "update" -
- parameters Repositoryruleupdate_parameters? -
github: Repositoryruleupdate_parameters
Fields
- update_allows_fetch_and_merge boolean - Branch can pull changes from its upstream repository
github: RepositorySubscription
Repository invitations let you manage who you collaborate with.
Fields
- subscribed boolean - Determines if notifications should be received from this repository.
- ignored boolean - Determines if all notifications should be blocked from this repository.
- reason string -
- created_at string -
- url string -
- repository_url string -
github: RepositoryWebhooks
The repository on GitHub where the event occurred. Webhook payloads contain the repository
property
when the event occurs from activity in a repository.
Fields
- id int - Unique identifier of the repository
- node_id string -
- name string - The name of the repository.
- full_name string -
- license NullableLicenseSimple - License Simple
- organization NullableSimpleUser? - A GitHub user.
- forks int -
- permissions Repository_permissions? -
- owner SimpleUser - A GitHub user.
- 'private boolean - Whether the repository is private or public.
- html_url string -
- description string -
- 'fork boolean -
- url string -
- archive_url string -
- assignees_url string -
- blobs_url string -
- branches_url string -
- collaborators_url string -
- comments_url string -
- commits_url string -
- compare_url string -
- contents_url string -
- contributors_url string -
- deployments_url string -
- downloads_url string -
- events_url string -
- forks_url string -
- git_commits_url string -
- git_refs_url string -
- git_tags_url string -
- git_url string -
- issue_comment_url string -
- issue_events_url string -
- issues_url string -
- keys_url string -
- labels_url string -
- languages_url string -
- merges_url string -
- milestones_url string -
- notifications_url string -
- pulls_url string -
- releases_url string -
- ssh_url string -
- stargazers_url string -
- statuses_url string -
- subscribers_url string -
- subscription_url string -
- tags_url string -
- teams_url string -
- trees_url string -
- clone_url string -
- mirror_url string -
- hooks_url string -
- svn_url string -
- homepage string -
- language string -
- forks_count int -
- stargazers_count int -
- watchers_count int -
- size int - The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- default_branch string - The default branch of the repository.
- open_issues_count int -
- is_template boolean(default false) - Whether this repository acts as a template that can be used to generate new repositories.
- topics string[]? -
- has_issues boolean - Whether issues are enabled.
- has_projects boolean - Whether projects are enabled.
- has_wiki boolean - Whether the wiki is enabled.
- has_pages boolean -
- has_downloads boolean - Whether downloads are enabled.
- has_discussions boolean(default false) - Whether discussions are enabled.
- archived boolean - Whether the repository is archived.
- disabled boolean - Returns whether or not this repository disabled.
- visibility string(default "public") - The repository visibility: public, private, or internal.
- pushed_at string -
- created_at string -
- updated_at string -
- allow_rebase_merge boolean(default true) - Whether to allow rebase merges for pull requests.
- template_repository Repository_template_repository? -
- temp_clone_token string? -
- allow_squash_merge boolean(default true) - Whether to allow squash merges for pull requests.
- allow_auto_merge boolean(default false) - Whether to allow Auto-merge to be used on pull requests.
- delete_branch_on_merge boolean(default false) - Whether to delete head branches when pull requests are merged
- allow_update_branch boolean(default false) - Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- use_squash_pr_title_as_default boolean(default false) - Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use
squash_merge_commit_title
instead.
- squash_merge_commit_title "PR_TITLE"|"COMMIT_OR_PR_TITLE" ? - The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- squash_merge_commit_message "PR_BODY"|"COMMIT_MESSAGES"|"BLANK" ? - The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- merge_commit_title "PR_TITLE"|"MERGE_MESSAGE" ? - The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- merge_commit_message "PR_BODY"|"PR_TITLE"|"BLANK" ? - The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- allow_merge_commit boolean(default true) - Whether to allow merge commits for pull requests.
- allow_forking boolean? - Whether to allow forking this repo
- web_commit_signoff_required boolean(default false) - Whether to require contributors to sign off on web-based commits
- subscribers_count int? -
- network_count int? -
- open_issues int -
- watchers int -
- master_branch string? -
- starred_at string? -
- anonymous_access_enabled boolean? - Whether anonymous git access is enabled for this repository
github: Reposownerrepo_security_and_analysis
Specify which security and analysis features to enable or disable for the repository.
To use this parameter, 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."
For example, to enable GitHub Advanced Security, use this data in the body of the PATCH
request:
{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }
.
You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo}
request.
Fields
- advanced_security Reposownerrepo_security_and_analysis_advanced_security? - Use the
status
property to enable or disable GitHub Advanced Security for this repository. For more information, see "About GitHub Advanced Security."
- secret_scanning Reposownerrepo_security_and_analysis_secret_scanning? - Use the
status
property to enable or disable secret scanning for this repository. For more information, see "About secret scanning."
- secret_scanning_push_protection Reposownerrepo_security_and_analysis_secret_scanning_push_protection? - Use the
status
property to enable or disable secret scanning push protection for this repository. For more information, see "Protecting pushes with secret scanning."
github: Reposownerrepo_security_and_analysis_advanced_security
Use the status
property to enable or disable GitHub Advanced Security for this repository. For more information, see "About GitHub Advanced Security."
Fields
- status string? - Can be
enabled
ordisabled
.
github: Reposownerrepo_security_and_analysis_secret_scanning
Use the status
property to enable or disable secret scanning for this repository. For more information, see "About secret scanning."
Fields
- status string? - Can be
enabled
ordisabled
.
github: Reposownerrepo_security_and_analysis_secret_scanning_push_protection
Use the status
property to enable or disable secret scanning push protection for this repository. For more information, see "Protecting pushes with secret scanning."
Fields
- status string? - Can be
enabled
ordisabled
.
github: Reposownerrepobranchesbranchprotection_required_pull_request_reviews
Require at least one approving review on a pull request, before merging. Set to null
to disable.
Fields
- dismissal_restrictions Reposownerrepobranchesbranchprotection_required_pull_request_reviews_dismissal_restrictions? - Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty
dismissal_restrictions
object to disable. User and teamdismissal_restrictions
are only available for organization-owned repositories. Omit this parameter for personal repositories.
- dismiss_stale_reviews boolean? - Set to
true
if you want to automatically dismiss approving reviews when someone pushes a new commit.
- require_code_owner_reviews boolean? - Blocks merging pull requests until code owners review them.
- required_approving_review_count int? - Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.
- require_last_push_approval boolean? - Whether the most recent push must be approved by someone other than the person who pushed it. Default:
false
.
- bypass_pull_request_allowances Reposownerrepobranchesbranchprotection_required_pull_request_reviews_bypass_pull_request_allowances? - Allow specific users, teams, or apps to bypass pull request requirements.
github: Reposownerrepobranchesbranchprotection_required_pull_request_reviews_bypass_pull_request_allowances
Allow specific users, teams, or apps to bypass pull request requirements.
Fields
- users string[]? - The list of user
login
s allowed to bypass pull request requirements.
- teams string[]? - The list of team
slug
s allowed to bypass pull request requirements.
- apps string[]? - The list of app
slug
s allowed to bypass pull request requirements.
github: Reposownerrepobranchesbranchprotection_required_pull_request_reviews_dismissal_restrictions
Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions
object to disable. User and team dismissal_restrictions
are only available for organization-owned repositories. Omit this parameter for personal repositories.
Fields
- users string[]? - The list of user
login
s with dismissal access
- teams string[]? - The list of team
slug
s with dismissal access
- apps string[]? - The list of app
slug
s with dismissal access
github: Reposownerrepobranchesbranchprotection_required_status_checks
Require status checks to pass before merging. Set to null
to disable.
Fields
- strict boolean - Require branches to be up to date before merging.
- contexts string[] - Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use
checks
instead ofcontexts
for more fine-grained control.
- checks Reposownerrepobranchesbranchprotection_required_status_checks_checks[]? - The list of status checks to require in order to merge into this branch.
github: Reposownerrepobranchesbranchprotection_required_status_checks_checks
Fields
- context string - The name of the required check
- app_id int? - The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.
github: Reposownerrepobranchesbranchprotection_restrictions
Restrict who can push to the protected branch. User, app, and team restrictions
are only available for organization-owned repositories. Set to null
to disable.
Fields
- users string[] - The list of user
login
s with push access
- teams string[] - The list of team
slug
s with push access
- apps string[]? - The list of app
slug
s with push access
github: Reposownerrepocheckruns_actions
Fields
- label string - The text to be displayed on a button in the web UI. The maximum size is 20 characters.
- description string - A short explanation of what this action would do. The maximum size is 40 characters.
- identifier string - A reference for the action on the integrator's system. The maximum size is 20 characters.
github: Reposownerrepocheckruns_output
Check runs can accept a variety of data in the output
object, including a title
and summary
and can optionally provide descriptive details about the run.
Fields
- title string - The title of the check run.
- summary string - The summary of the check run. This parameter supports Markdown. Maximum length: 65535 characters.
- text string? - The details of the check run. This parameter supports Markdown. Maximum length: 65535 characters.
- annotations Reposownerrepocheckruns_output_annotations[]? - Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "About status checks".
- images Reposownerrepocheckruns_output_images[]? - Adds images to the output displayed in the GitHub pull request UI.
github: Reposownerrepocheckruns_output_annotations
Fields
- path string - The path of the file to add an annotation to. For example,
assets/css/main.css
.
- start_line int - The start line of the annotation. Line numbers start at 1.
- end_line int - The end line of the annotation.
- start_column int? - The start column of the annotation. Annotations only support
start_column
andend_column
on the same line. Omit this parameter ifstart_line
andend_line
have different values. Column numbers start at 1.
- end_column int? - The end column of the annotation. Annotations only support
start_column
andend_column
on the same line. Omit this parameter ifstart_line
andend_line
have different values.
- annotation_level "notice"|"warning"|"failure" - The level of the annotation.
- message string - A short description of the feedback for these lines of code. The maximum size is 64 KB.
- title string? - The title that represents the annotation. The maximum size is 255 characters.
- raw_details string? - Details about this annotation. The maximum size is 64 KB.
github: Reposownerrepocheckruns_output_images
Fields
- alt string - The alternative text for the image.
- image_url string - The full URL of the image.
github: Reposownerrepocheckrunscheck_run_id_output
Check runs can accept a variety of data in the output
object, including a title
and summary
and can optionally provide descriptive details about the run.
Fields
- title string? - Required.
- summary string - Can contain Markdown.
- text string? - Can contain Markdown.
- annotations Reposownerrepocheckruns_output_annotations[]? - Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "About status checks".
- images Reposownerrepocheckruns_output_images[]? - Adds images to the output displayed in the GitHub pull request UI.
github: Reposownerrepochecksuitespreferences_auto_trigger_checks
Fields
- app_id int - The
id
of the GitHub App.
- setting boolean - Set to
true
to enable automatic creation of CheckSuite events upon pushes to the repository, orfalse
to disable them.
github: Reposownerrepocontentspath_author
The author of the file. Default: The committer
or the authenticated user if you omit committer
.
Fields
- name string - The name of the author or committer of the commit. You'll receive a
422
status code ifname
is omitted.
- email string - The email of the author or committer of the commit. You'll receive a
422
status code ifemail
is omitted.
- date string? -
github: Reposownerrepocontentspath_author_1
object containing information about the author.
Fields
- name string? - The name of the author (or committer) of the commit
- email string? - The email of the author (or committer) of the commit
github: Reposownerrepocontentspath_committer
The person that committed the file. Default: the authenticated user.
Fields
- name string - The name of the author or committer of the commit. You'll receive a
422
status code ifname
is omitted.
- email string - The email of the author or committer of the commit. You'll receive a
422
status code ifemail
is omitted.
- date string? -
github: Reposownerrepocontentspath_committer_1
object containing information about the committer.
Fields
- name string? - The name of the author (or committer) of the commit
- email string? - The email of the author (or committer) of the commit
github: Reposownerrepoenvironmentsenvironment_name_reviewers
Fields
- 'type DeploymentReviewerType? - The type of reviewer.
- id int? - The id of the user or team who can review the deployment
github: Reposownerrepogitcommits_author
Information about the author of the commit. By default, the author
will be the authenticated user and the current date. See the author
and committer
object below for details.
Fields
- name string - The name of the author (or committer) of the commit
- email string - The email of the author (or committer) of the commit
github: Reposownerrepogitcommits_committer
Information about the person who is making the commit. By default, committer
will use the information set in author
. See the author
and committer
object below for details.
Fields
- name string? - The name of the author (or committer) of the commit
- email string? - The email of the author (or committer) of the commit
github: Reposownerrepogittags_tagger
An object with information about the individual creating the tag.
Fields
- name string - The name of the author of the tag
- email string - The email of the author of the tag
github: Reposownerrepogittrees_tree
Fields
- path string? - The file referenced in the tree.
- mode "100644"|"100755"|"040000"|"160000"|"120000" ? - The file mode; one of
100644
for file (blob),100755
for executable (blob),040000
for subdirectory (tree),160000
for submodule (commit), or120000
for a blob that specifies the path of a symlink.
- 'type "blob"|"tree"|"commit" ? - Either
blob
,tree
, orcommit
.
- sha string? - The SHA1 checksum ID of the object in the tree. Also called
tree.sha
. If the value isnull
then the file will be deleted. Note: Use eithertree.sha
orcontent
to specify the contents of the entry. Using bothtree.sha
andcontent
will return an error.
- content string? - The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or
tree.sha
. Note: Use eithertree.sha
orcontent
to specify the contents of the entry. Using bothtree.sha
andcontent
will return an error.
github: Reposownerrepohooks_config
Key/value pairs to provide settings for this webhook.
Fields
- url WebhookConfigUrl? - The URL to which the payloads will be delivered.
- content_type WebhookConfigContentType? - The media type used to serialize the payloads. Supported values include
json
andform
. The default isform
.
- secret WebhookConfigSecret? - If provided, the
secret
will be used as thekey
to generate the HMAC hex digest value for delivery signature headers.
- insecure_ssl WebhookConfigInsecureSsl? -
- token string? -
- digest string? -
github: Reposownerrepohookshook_id_config
Key/value pairs to provide settings for this webhook.
Fields
- url WebhookConfigUrl - The URL to which the payloads will be delivered.
- content_type WebhookConfigContentType? - The media type used to serialize the payloads. Supported values include
json
andform
. The default isform
.
- secret WebhookConfigSecret? - If provided, the
secret
will be used as thekey
to generate the HMAC hex digest value for delivery signature headers.
- insecure_ssl WebhookConfigInsecureSsl? -
- address string? -
- room string? -
github: Reposownerrepoissuesissue_numberlabels_labels
Fields
- name string -
github: Reposownerrepopages_source
The source branch and directory used to publish your Pages site.
Fields
- branch string - The repository branch used to publish your site's source files.
- path "/"|"/docs" (default "/") - The repository directory that includes the source files for the Pages site. Allowed paths are
/
or/docs
. Default:/
github: Reposownerrepopullspull_numberreviews_comments
Fields
- path string - The relative path to the file that necessitates a review comment.
- position int? - The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.
- body string - Text of the review comment.
- line int? -
- side string? -
- start_line int? -
- start_side string? -
github: Review_id_dismissals_body
Fields
- message string - The message for the pull request review dismissal
- event "DISMISS" ? -
github: Review_id_events_body
Fields
- body string? - The body text of the pull request review
- event "APPROVE"|"REQUEST_CHANGES"|"COMMENT" - The review action you want to perform. The review actions include:
APPROVE
,REQUEST_CHANGES
, orCOMMENT
. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state toPENDING
, which means you will need to re-submit the pull request review using a review action.
github: ReviewComment
Legacy Review Comment
Fields
- url string -
- pull_request_review_id int -
- id int -
- node_id string -
- diff_hunk string -
- path string -
- position int -
- original_position int -
- commit_id string -
- original_commit_id string -
- in_reply_to_id int? -
- user NullableSimpleUser - A GitHub user.
- body string -
- created_at string -
- updated_at string -
- html_url string -
- pull_request_url string -
- author_association AuthorAssociation - How the author is associated with the repository.
- _links Reviewcomment__links -
- body_text string? -
- body_html string? -
- reactions ReactionRollup? -
- side "LEFT"|"RIGHT" (default "RIGHT") - The side of the first line of the range for a multi-line comment.
- start_side "LEFT"|"RIGHT" (default "RIGHT") - The side of the first line of the range for a multi-line comment.
- line int? - The line of the blob to which the comment applies. The last line of the range for a multi-line comment
- original_line int? - The original line of the blob to which the comment applies. The last line of the range for a multi-line comment
- start_line int? - The first line of the range for a multi-line comment.
- original_start_line int? - The original first line of the range for a multi-line comment.
github: Reviewcomment__links
Fields
- self Link - Hypermedia Link
- html Link - Hypermedia Link
- pull_request Link - Hypermedia Link
github: ReviewCustomGatesCommentRequired
Fields
- environment_name string - The name of the environment to approve or reject.
- comment string - Comment associated with the pending deployment protection rule. Required when state is not provided.
github: ReviewCustomGatesStateRequired
Fields
- environment_name string - The name of the environment to approve or reject.
- state "approved"|"rejected" - Whether to approve or reject deployment to the specified environments.
- comment string? - Optional comment to include with the review.
github: ReviewDismissedIssueEvent
Review Dismissed Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- dismissed_review Reviewdismissedissueevent_dismissed_review -
github: Reviewdismissedissueevent_dismissed_review
Fields
- state string -
- review_id int -
- dismissal_message string -
- dismissal_commit_id string? -
github: ReviewRequestedIssueEvent
Review Requested Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- review_requester SimpleUser - A GitHub user.
- requested_team Team? - Groups of organization members that gives permissions on specified repositories.
- requested_reviewer SimpleUser? - A GitHub user.
github: ReviewRequestRemovedIssueEvent
Review Request Removed Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- review_requester SimpleUser - A GitHub user.
- requested_team Team? - Groups of organization members that gives permissions on specified repositories.
- requested_reviewer SimpleUser? - A GitHub user.
github: Reviews_review_id_body
Fields
- body string - The body text of the pull request review.
github: Root
Fields
- current_user_url string -
- current_user_authorizations_html_url string -
- authorizations_url string -
- code_search_url string -
- commit_search_url string -
- emails_url string -
- emojis_url string -
- events_url string -
- feeds_url string -
- followers_url string -
- following_url string -
- gists_url string -
- hub_url string -
- issue_search_url string -
- issues_url string -
- keys_url string -
- label_search_url string -
- notifications_url string -
- organization_url string -
- organization_repositories_url string -
- organization_teams_url string -
- public_gists_url string -
- rate_limit_url string -
- repository_url string -
- repository_search_url string -
- current_user_repositories_url string -
- starred_url string -
- starred_gists_url string -
- topic_search_url string? -
- user_url string -
- user_organizations_url string -
- user_repositories_url string -
- user_search_url string -
github: Rulesets_ruleset_id_body
Fields
- name string? - The name of the ruleset.
- target "branch"|"tag" ? - The target of the ruleset.
- enforcement RepositoryRuleEnforcement? - The enforcement level of the ruleset.
evaluate
allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate
is only available with GitHub Enterprise).
- bypass_actors RepositoryRulesetBypassActor[]? - The actors that can bypass the rules in this ruleset
- conditions OrgRulesetConditions? - Conditions for an organization ruleset. The conditions object should contain both
repository_name
andref_name
properties or bothrepository_id
andref_name
properties.
- rules RepositoryRule[]? - An array of rules within the ruleset.
github: Rulesets_ruleset_id_body_1
Fields
- name string? - The name of the ruleset.
- target "branch"|"tag" ? - The target of the ruleset.
- enforcement RepositoryRuleEnforcement? - The enforcement level of the ruleset.
evaluate
allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate
is only available with GitHub Enterprise).
- bypass_actors RepositoryRulesetBypassActor[]? - The actors that can bypass the rules in this ruleset
- conditions RepositoryRulesetConditions? - Parameters for a repository ruleset ref name condition
- rules RepositoryRule[]? - An array of rules within the ruleset.
github: RuleSuite
Response
Fields
- id int? - The unique identifier of the rule insight.
- actor_id int? - The number that identifies the user.
- actor_name string? - The handle for the GitHub user account.
- before_sha string? - The first commit sha before the push evaluation.
- after_sha string? - The last commit sha in the push evaluation.
- ref string? - The ref name that the evaluation ran on.
- repository_id int? - The ID of the repository associated with the rule evaluation.
- repository_name string? - The name of the repository without the
.git
extension.
- pushed_at string? -
- result "pass"|"fail"|"bypass" ? - The result of the rule evaluations for rules with the
active
enforcement status.
- evaluation_result "pass"|"fail" ? - The result of the rule evaluations for rules with the
active
andevaluate
enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite wereactive
.
- rule_evaluations Rulesuite_rule_evaluations[]? - Details on the evaluated rules.
github: Rulesuite_rule_evaluations
Fields
- rule_source Rulesuite_rule_source? -
- enforcement "active"|"evaluate"|"deleted ruleset" ? - The enforcement level of this rule source.
- result "pass"|"fail" ? - The result of the evaluation of the individual rule.
- rule_type string? - The type of rule.
- details string? - Any associated details with the rule evaluation.
github: Rulesuite_rule_source
Fields
- 'type string? - The type of rule source.
- id int? - The ID of the rule source.
- name string? - The name of the rule source.
github: Rulesuites_inner
Fields
- id int? - The unique identifier of the rule insight.
- actor_id int? - The number that identifies the user.
- actor_name string? - The handle for the GitHub user account.
- before_sha string? - The first commit sha before the push evaluation.
- after_sha string? - The last commit sha in the push evaluation.
- ref string? - The ref name that the evaluation ran on.
- repository_id int? - The ID of the repository associated with the rule evaluation.
- repository_name string? - The name of the repository without the
.git
extension.
- pushed_at string? -
- result "pass"|"fail"|"bypass" ? - The result of the rule evaluations for rules with the
active
enforcement status.
- evaluation_result "pass"|"fail" ? - The result of the rule evaluations for rules with the
active
andevaluate
enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite wereactive
.
github: Run_id_pending_deployments_body
Fields
- environment_ids int[] - The list of environment ids to approve or reject
- state "approved"|"rejected" - Whether to approve or reject deployment to the specified environments.
- comment string - A comment to accompany the deployment review
github: Run_id_rerun_body
Fields
- enable_debug_logging boolean? - Whether to enable debug logging for the re-run.
github: Run_id_rerunfailedjobs_body
Fields
- enable_debug_logging boolean? - Whether to enable debug logging for the re-run.
github: Runner
A self hosted runner
Fields
- id int - The id of the runner.
- runner_group_id int? - The id of the runner group.
- name string - The name of the runner.
- os string - The Operating System of the runner.
- status string - The status of the runner.
- busy boolean -
- labels RunnerLabel[] -
github: Runner_id_labels_body
Fields
- labels string[] - The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.
github: Runner_id_labels_body_1
Fields
- labels string[] - The names of the custom labels to add to the runner.
github: Runner_id_labels_body_2
Fields
- labels string[] - The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.
github: Runner_id_labels_body_3
Fields
- labels string[] - The names of the custom labels to add to the runner.
github: RunnerApplication
Runner Application
Fields
- os string -
- architecture string -
- download_url string -
- filename string -
- temp_download_token string? - A short lived bearer token used to download the runner, if needed.
- sha256_checksum string? -
github: RunnerLabel
A label for a self hosted runner
Fields
- id int? - Unique identifier of the label.
- name string - Name of the label.
- 'type "read-only"|"custom" ? - The type of label. Read-only labels are applied automatically when the runner is configured.
github: RunnerLabelResponse
A label for a self hosted runner
Fields
- total_count int -
- labels RunnerLabel[] -
github: RunnerResponse
A self hosted runner
Fields
- total_count int -
- runners Runner[] -
github: Runners_generatejitconfig_body
Fields
- name string - The name of the new runner.
- runner_group_id int - The ID of the runner group to register the runner to.
- labels string[] - The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.
- work_folder string(default "_work") - The working directory to be used for job execution, relative to the runner install directory.
github: Runners_generatejitconfig_body_1
Fields
- name string - The name of the new runner.
- runner_group_id int - The ID of the runner group to register the runner to.
- labels string[] - The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.
- work_folder string(default "_work") - The working directory to be used for job execution, relative to the runner install directory.
github: ScimError
Scim Error
Fields
- message string? -
- documentation_url string? -
- detail string? -
- status int? -
- scimType string? -
- schemas string[]? -
github: Searchresulttextmatches_inner
Fields
- object_url string? -
- object_type string? -
- property string? -
- fragment string? -
github: Secret_name_repositories_body
Fields
- selected_repository_ids int[] - An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the
visibility
is set toselected
. You can add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.
github: Secret_name_repositories_body_1
Fields
- selected_repository_ids int[] - An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the
visibility
is set toselected
. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.
github: Secret_name_repositories_body_2
Fields
- selected_repository_ids int[] - An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the
visibility
is set toselected
. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.
github: Secret_name_repositories_body_3
Fields
- selected_repository_ids int[] - An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Add a selected repository to a user secret, and Remove a selected repository from a user secret endpoints.
github: Secrets_secret_name_body
Fields
- encrypted_value string? - Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
- key_id string? - ID of the key you used to encrypt the secret.
- visibility "all"|"private"|"selected" - Which type of organization repositories have access to the organization secret.
selected
means only the repositories specified byselected_repository_ids
can access the secret.
- selected_repository_ids int[]? - An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the
visibility
is set toselected
. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
github: Secrets_secret_name_body_1
Fields
- encrypted_value string? - The value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
- key_id string? - The ID of the key you used to encrypt the secret.
- visibility "all"|"private"|"selected" - Which type of organization repositories have access to the organization secret.
selected
means only the repositories specified byselected_repository_ids
can access the secret.
- selected_repository_ids int[]? - An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the
visibility
is set toselected
. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
github: Secrets_secret_name_body_2
Fields
- encrypted_value string? - Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
- key_id string? - ID of the key you used to encrypt the secret.
- visibility "all"|"private"|"selected" - Which type of organization repositories have access to the organization secret.
selected
means only the repositories specified byselected_repository_ids
can access the secret.
- selected_repository_ids string[]? - An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the
visibility
is set toselected
. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
github: Secrets_secret_name_body_3
Fields
- encrypted_value string? - Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
- key_id string? - ID of the key you used to encrypt the secret.
github: Secrets_secret_name_body_4
Fields
- encrypted_value string? - Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
- key_id string? - ID of the key you used to encrypt the secret.
github: Secrets_secret_name_body_5
Fields
- encrypted_value string? - Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
- key_id string? - ID of the key you used to encrypt the secret.
github: Secrets_secret_name_body_6
Fields
- encrypted_value string - Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.
- key_id string - ID of the key you used to encrypt the secret.
github: Secrets_secret_name_body_7
Fields
- encrypted_value string? - Value for your secret, encrypted with LibSodium using the public key retrieved from the Get the public key for the authenticated user endpoint.
- key_id string - ID of the key you used to encrypt the secret.
- selected_repository_ids (int|string)[]? - An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.
github: SecretScanningAlert
Fields
- number AlertNumber? - The security alert number.
- created_at AlertCreatedAt? - The time that the alert was created in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- updated_at NullableAlertUpdatedAt? - The time that the alert was last updated in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- url AlertUrl? - The REST API URL of the alert resource.
- html_url AlertHtmlUrl? - The GitHub URL of the alert resource.
- locations_url string? - The REST API URL of the code locations for this alert.
- state SecretScanningAlertState? - Sets the state of the secret scanning alert. You must provide
resolution
when you set the state toresolved
.
- resolution SecretScanningAlertResolution? - Required when the
state
isresolved
. The reason for resolving the alert.
- resolved_at string? - The time that the alert was resolved in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
- resolved_by NullableSimpleUser? - A GitHub user.
- resolution_comment string? - An optional comment to resolve an alert.
- secret_type string? - The type of secret that secret scanning detected.
- secret_type_display_name string? - User-friendly name for the detected secret, matching the
secret_type
. For a list of built-in patterns, see "Secret scanning patterns."
- secret string? - The secret that was detected.
- push_protection_bypassed boolean? - Whether push protection was bypassed for the detected secret.
- push_protection_bypassed_by NullableSimpleUser? - A GitHub user.
- push_protection_bypassed_at string? - The time that push protection was bypassed in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
.
github: SecretScanningLocation
Fields
- 'type "commit"|"issue_title"|"issue_body"|"issue_comment" - The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found.
github: SecretScanningLocationCommit
Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
Fields
- path string - The file path in the repository
- start_line decimal - Line number at which the secret starts in the file
- end_line decimal - Line number at which the secret ends in the file
- start_column decimal - The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII
- end_column decimal - The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII
- blob_sha string - SHA-1 hash ID of the associated blob
- blob_url string - The API URL to get the associated blob resource
- commit_sha string - SHA-1 hash ID of the associated commit
- commit_url string - The API URL to get the associated commit resource
github: SecretScanningLocationIssueBody
Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
Fields
- issue_body_url string - The API URL to get the issue where the secret was detected.
github: SecretScanningLocationIssueComment
Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
Fields
- issue_comment_url string - The API URL to get the issue comment where the secret was detected.
github: SecretScanningLocationIssueTitle
Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
Fields
- issue_title_url string - The API URL to get the issue where the secret was detected.
github: Security_product_enablement_body
Fields
- query_suite "default"|"extended" ? - CodeQL query suite to be used. If you specify the
query_suite
parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. If you don't specify anyquery_suite
in your request, the preferred query suite of the organization will be applied.
github: SecurityAndAnalysis
Fields
- advanced_security Securityandanalysis_advanced_security? -
- dependabot_security_updates Securityandanalysis_dependabot_security_updates? - Enable or disable Dependabot security updates for the repository.
- secret_scanning Securityandanalysis_advanced_security? -
- secret_scanning_push_protection Securityandanalysis_advanced_security? -
github: Securityandanalysis_advanced_security
Fields
- status "enabled"|"disabled" ? -
github: Securityandanalysis_dependabot_security_updates
Enable or disable Dependabot security updates for the repository.
Fields
- status "enabled"|"disabled" ? - The enablement status of Dependabot security updates for the repository.
github: SelectedActions
Fields
- github_owned_allowed boolean? - Whether GitHub-owned actions are allowed. For example, this includes the actions in the
actions
organization.
- verified_allowed boolean? - Whether actions from GitHub Marketplace verified creators are allowed. Set to
true
to allow all actions by GitHub Marketplace verified creators.
- patterns_allowed string[]? - Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example,
monalisa/octocat@*
,monalisa/octocat@v2
,monalisa/*
. Note: Thepatterns_allowed
setting only applies to public repositories.
github: ShortBlob
Short Blob
Fields
- url string -
- sha string -
github: ShortBranch
Short Branch
Fields
- name string -
- 'commit Shortbranch_commit -
- protected boolean -
- protection BranchProtection? - Branch Protection
- protection_url string? -
github: Shortbranch_commit
Fields
- sha string -
- url string -
github: SimpleClassroom
A GitHub Classroom classroom
Fields
- id int - Unique identifier of the classroom.
- name string - The name of the classroom.
- archived boolean - Returns whether classroom is archived or not.
- url string - The url of the classroom on GitHub Classroom.
github: SimpleClassroomAssignment
A GitHub Classroom assignment
Fields
- id int - Unique identifier of the repository.
- public_repo boolean - Whether an accepted assignment creates a public repository.
- title string - Assignment title.
- 'type "individual"|"group" - Whether it's a Group Assignment or Individual Assignment.
- invite_link string - The link that a student can use to accept the assignment.
- invitations_enabled boolean - Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.
- slug string - Sluggified name of the assignment.
- students_are_repo_admins boolean - Whether students are admins on created repository on accepted assignment.
- feedback_pull_requests_enabled boolean - Whether feedback pull request will be created on assignment acceptance.
- max_teams int? - The maximum allowable teams for the assignment.
- max_members int? - The maximum allowable members per team.
- editor string - The selected editor for the assignment.
- accepted int - The number of students that have accepted the assignment.
- submitted int - The number of students that have submitted the assignment.
- passing int - The number of students that have passed the assignment.
- language string - The programming language used in the assignment.
- deadline string - The time at which the assignment is due.
- classroom SimpleClassroom - A GitHub Classroom classroom
github: SimpleClassroomOrganization
A GitHub organization.
Fields
- id int -
- login string -
- node_id string -
- html_url string -
- name string -
- avatar_url string -
github: SimpleClassroomRepository
A GitHub repository view for Classroom
Fields
- id int - A unique identifier of the repository.
- full_name string - The full, globally unique name of the repository.
- html_url string - The URL to view the repository on GitHub.com.
- node_id string - The GraphQL identifier of the repository.
- 'private boolean - Whether the repository is private.
- default_branch string - The default branch for the repository.
github: SimpleClassroomUser
A GitHub user simplified for Classroom.
Fields
- id int -
- login string -
- avatar_url string -
- html_url string -
github: SimpleCommit
A commit.
Fields
- id string - SHA for the commit
- tree_id string - SHA for the commit's tree
- message string - Message describing the purpose of the commit
- timestamp string - Timestamp of the commit
- author Nullablesimplecommit_author - Information about the Git author
- committer Nullablesimplecommit_committer - Information about the Git committer
github: SimpleCommitStatus
Fields
- description string -
- id int -
- node_id string -
- state string -
- context string -
- target_url string -
- required boolean? -
- avatar_url string -
- url string -
- created_at string -
- updated_at string -
github: SimpleRepository
A GitHub repository.
Fields
- id int - A unique identifier of the repository.
- node_id string - The GraphQL identifier of the repository.
- name string - The name of the repository.
- full_name string - The full, globally unique, name of the repository.
- owner SimpleUser - A GitHub user.
- 'private boolean - Whether the repository is private.
- html_url string - The URL to view the repository on GitHub.com.
- description string - The repository description.
- 'fork boolean - Whether the repository is a fork.
- url string - The URL to get more information about the repository from the GitHub API.
- archive_url string - A template for the API URL to download the repository as an archive.
- assignees_url string - A template for the API URL to list the available assignees for issues in the repository.
- blobs_url string - A template for the API URL to create or retrieve a raw Git blob in the repository.
- branches_url string - A template for the API URL to get information about branches in the repository.
- collaborators_url string - A template for the API URL to get information about collaborators of the repository.
- comments_url string - A template for the API URL to get information about comments on the repository.
- commits_url string - A template for the API URL to get information about commits on the repository.
- compare_url string - A template for the API URL to compare two commits or refs.
- contents_url string - A template for the API URL to get the contents of the repository.
- contributors_url string - A template for the API URL to list the contributors to the repository.
- deployments_url string - The API URL to list the deployments of the repository.
- downloads_url string - The API URL to list the downloads on the repository.
- events_url string - The API URL to list the events of the repository.
- forks_url string - The API URL to list the forks of the repository.
- git_commits_url string - A template for the API URL to get information about Git commits of the repository.
- git_refs_url string - A template for the API URL to get information about Git refs of the repository.
- git_tags_url string - A template for the API URL to get information about Git tags of the repository.
- issue_comment_url string - A template for the API URL to get information about issue comments on the repository.
- issue_events_url string - A template for the API URL to get information about issue events on the repository.
- issues_url string - A template for the API URL to get information about issues on the repository.
- keys_url string - A template for the API URL to get information about deploy keys on the repository.
- labels_url string - A template for the API URL to get information about labels of the repository.
- languages_url string - The API URL to get information about the languages of the repository.
- merges_url string - The API URL to merge branches in the repository.
- milestones_url string - A template for the API URL to get information about milestones of the repository.
- notifications_url string - A template for the API URL to get information about notifications on the repository.
- pulls_url string - A template for the API URL to get information about pull requests on the repository.
- releases_url string - A template for the API URL to get information about releases on the repository.
- stargazers_url string - The API URL to list the stargazers on the repository.
- statuses_url string - A template for the API URL to get information about statuses of a commit.
- subscribers_url string - The API URL to list the subscribers on the repository.
- subscription_url string - The API URL to subscribe to notifications for this repository.
- tags_url string - The API URL to get information about tags on the repository.
- teams_url string - The API URL to list the teams on the repository.
- trees_url string - A template for the API URL to create or retrieve a raw Git tree of the repository.
- hooks_url string - The API URL to list the hooks on the repository.
github: SimpleUser
A GitHub user.
Fields
- name string? -
- email string? -
- login string -
- id int -
- node_id string -
- avatar_url string -
- gravatar_id string -
- url string -
- html_url string -
- followers_url string -
- following_url string -
- gists_url string -
- starred_url string -
- subscriptions_url string -
- organizations_url string -
- repos_url string -
- events_url string -
- received_events_url string -
- 'type string -
- site_admin boolean -
- starred_at string? -
github: Snapshot
Create a new snapshot of a repository's dependencies.
Fields
- version int - The version of the repository snapshot submission.
- job Snapshot_job -
- sha string - The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.
- ref string - The repository branch that triggered this snapshot.
- detector Snapshot_detector - A description of the detector used.
- metadata Metadata? - User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
- manifests record { Manifest... }? - A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.
- scanned string - The time at which the snapshot was scanned.
github: Snapshot_detector
A description of the detector used.
Fields
- name string - The name of the detector used.
- version string - The version of the detector used.
- url string - The url of the detector used.
github: Snapshot_job
Fields
- id string - The external ID of the job.
- correlator string - Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of
job.correlator
anddetector.name
will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.
- html_url string? - The url for the job.
github: SnapshotResponse
Snapshot of a newly created repository's dependencies.
Fields
- id int - ID of the created snapshot.
- created_at string - The time at which the snapshot was created.
- result string - Either "SUCCESS", "ACCEPTED", or "INVALID". "SUCCESS" indicates that the snapshot was successfully created and the repository's dependencies were updated. "ACCEPTED" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. "INVALID" indicates that the snapshot was malformed.
- message string - A message providing further details about the result, such as why the dependencies were not updated.
github: SocialAccount
Social media account
Fields
- provider string -
- url string -
github: SshSigningKey
A public SSH key used to sign Git commits
Fields
- 'key string -
- id int -
- title string -
- created_at string -
github: Stargazer
Stargazer
Fields
- starred_at string -
- user NullableSimpleUser - A GitHub user.
github: StarredRepository
Starred Repository
Fields
- starred_at string -
- repo Repository - A repository on GitHub.
github: StateChangeIssueEvent
State Change Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- state_reason string? -
github: Status
The status of a commit.
Fields
- url string -
- avatar_url string -
- id int -
- node_id string -
- state string -
- description string -
- target_url string -
- context string -
- created_at string -
- updated_at string -
- creator NullableSimpleUser - A GitHub user.
github: StatusCheckPolicy
Status Check Policy
Fields
- url string -
- strict boolean -
- contexts string[] -
- checks Statuscheckpolicy_checks[] -
- contexts_url string -
github: Statuscheckpolicy_checks
Fields
- context string -
- app_id int -
github: Statuses_sha_body
Fields
- state "error"|"failure"|"pending"|"success" - The state of the status.
- target_url string? - The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.
For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:
http://ci.example.com/user/repo/build/sha
- description string? - A short description of the status.
- context string(default "default") - A string label to differentiate this status from the status of other systems. This field is case-insensitive.
github: Tag
Tag
Fields
- name string -
- 'commit Shortbranch_commit -
- zipball_url string -
- tarball_url string -
- node_id string -
github: TagProtection
Tag protection
Fields
- id int? -
- created_at string? -
- updated_at string? -
- enabled boolean? -
- pattern string -
github: Tags_protection_body
Fields
- pattern string - An optional glob pattern to match against when enforcing tag protection.
github: Team
Groups of organization members that gives permissions on specified repositories.
Fields
- id int -
- node_id string -
- name string -
- slug string -
- description string -
- privacy string? -
- notification_setting string? -
- permission string -
- permissions Team_permissions? -
- url string -
- html_url string -
- members_url string -
- repositories_url string -
- parent NullableTeamSimple - Groups of organization members that gives permissions on specified repositories.
github: Team_id_discussions_body
Fields
- title string - The discussion post's title.
- body string - The discussion post's body text.
- 'private boolean(default false) - Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to
true
to create a private post.
github: Team_permissions
Fields
- pull boolean -
- triage boolean -
- push boolean -
- maintain boolean -
- admin boolean -
github: Team_slug_discussions_body
Fields
- title string - The discussion post's title.
- body string - The discussion post's body text.
- 'private boolean(default false) - Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to
true
to create a private post.
github: TeamDiscussion
A team discussion is a persistent record of a free-form conversation within a team.
Fields
- author NullableSimpleUser - A GitHub user.
- body string - The main text of the discussion.
- body_html string -
- body_version string - The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
- comments_count int -
- comments_url string -
- created_at string -
- last_edited_at string -
- html_url string -
- node_id string -
- number int - The unique sequence number of a team discussion.
- pinned boolean - Whether or not this discussion should be pinned for easy retrieval.
- 'private boolean - Whether or not this discussion should be restricted to team members and organization administrators.
- team_url string -
- title string - The title of the discussion.
- updated_at string -
- url string -
- reactions ReactionRollup? -
github: TeamDiscussionComment
A reply to a discussion within a team.
Fields
- author NullableSimpleUser - A GitHub user.
- body string - The main text of the comment.
- body_html string -
- body_version string - The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
- created_at string -
- last_edited_at string -
- discussion_url string -
- html_url string -
- node_id string -
- number int - The unique sequence number of a team discussion comment.
- updated_at string -
- url string -
- reactions ReactionRollup? -
github: TeamFull
Groups of organization members that gives permissions on specified repositories.
Fields
- id int - Unique identifier of the team
- node_id string -
- url string - URL for the team
- html_url string -
- name string - Name of the team
- slug string -
- description string -
- privacy "closed"|"secret" ? - The level of privacy this team should have
- notification_setting "notifications_enabled"|"notifications_disabled" ? - The notification setting the team has set
- permission string - Permission that the team will have for its repositories
- members_url string -
- repositories_url string -
- parent NullableTeamSimple? - Groups of organization members that gives permissions on specified repositories.
- members_count int -
- repos_count int -
- created_at string -
- updated_at string -
- organization TeamOrganization - Team Organization
- ldap_dn string? - Distinguished Name (DN) that team maps to within LDAP environment
github: TeamMembership
Team Membership
Fields
- url string -
- role "member"|"maintainer" - The role of the user in the team.
- state "active"|"pending" - The state of the user's membership in the team.
github: TeamOrganization
Team Organization
Fields
- login string -
- id int -
- node_id string -
- url string -
- repos_url string -
- events_url string -
- hooks_url string -
- issues_url string -
- members_url string -
- public_members_url string -
- avatar_url string -
- description string -
- name string? -
- company string? -
- blog string? -
- location string? -
- email string? -
- twitter_username string? -
- is_verified boolean? -
- has_organization_projects boolean -
- has_repository_projects boolean -
- public_repos int -
- public_gists int -
- followers int -
- following int -
- html_url string -
- created_at string -
- 'type string -
- total_private_repos int? -
- owned_private_repos int? -
- private_gists int? -
- disk_usage int? -
- collaborators int? -
- billing_email string? -
- plan Organizationfull_plan? -
- default_repository_permission string? -
- members_can_create_repositories boolean? -
- two_factor_requirement_enabled boolean? -
- members_allowed_repository_creation_type string? -
- members_can_create_public_repositories boolean? -
- members_can_create_private_repositories boolean? -
- members_can_create_internal_repositories boolean? -
- members_can_create_pages boolean? -
- members_can_create_public_pages boolean? -
- members_can_create_private_pages boolean? -
- members_can_fork_private_repositories boolean? -
- web_commit_signoff_required boolean? -
- updated_at string -
- archived_at string -
github: TeamProject
A team's access to a project.
Fields
- owner_url string -
- url string -
- html_url string -
- columns_url string -
- id int -
- node_id string -
- name string -
- body string -
- number int -
- state string -
- creator SimpleUser - A GitHub user.
- created_at string -
- updated_at string -
- organization_permission string? - The organization permission for this project. Only present when owner is an organization.
- 'private boolean? - Whether the project is private or not. Only present when owner is an organization.
- permissions Teamproject_permissions -
github: Teamproject_permissions
Fields
- read boolean -
- write boolean -
- admin boolean -
github: TeamRepository
A team's access to a repository.
Fields
- id int - Unique identifier of the repository
- node_id string -
- name string - The name of the repository.
- full_name string -
- license NullableLicenseSimple - License Simple
- forks int -
- permissions Repository_permissions? -
- role_name string? -
- owner NullableSimpleUser - A GitHub user.
- 'private boolean - Whether the repository is private or public.
- html_url string -
- description string -
- 'fork boolean -
- url string -
- archive_url string -
- assignees_url string -
- blobs_url string -
- branches_url string -
- collaborators_url string -
- comments_url string -
- commits_url string -
- compare_url string -
- contents_url string -
- contributors_url string -
- deployments_url string -
- downloads_url string -
- events_url string -
- forks_url string -
- git_commits_url string -
- git_refs_url string -
- git_tags_url string -
- git_url string -
- issue_comment_url string -
- issue_events_url string -
- issues_url string -
- keys_url string -
- labels_url string -
- languages_url string -
- merges_url string -
- milestones_url string -
- notifications_url string -
- pulls_url string -
- releases_url string -
- ssh_url string -
- stargazers_url string -
- statuses_url string -
- subscribers_url string -
- subscription_url string -
- tags_url string -
- teams_url string -
- trees_url string -
- clone_url string -
- mirror_url string -
- hooks_url string -
- svn_url string -
- homepage string -
- language string -
- forks_count int -
- stargazers_count int -
- watchers_count int -
- size int -
- default_branch string - The default branch of the repository.
- open_issues_count int -
- is_template boolean(default false) - Whether this repository acts as a template that can be used to generate new repositories.
- topics string[]? -
- has_issues boolean - Whether issues are enabled.
- has_projects boolean - Whether projects are enabled.
- has_wiki boolean - Whether the wiki is enabled.
- has_pages boolean -
- has_downloads boolean - Whether downloads are enabled.
- archived boolean - Whether the repository is archived.
- disabled boolean - Returns whether or not this repository disabled.
- visibility string(default "public") - The repository visibility: public, private, or internal.
- pushed_at string -
- created_at string -
- updated_at string -
- allow_rebase_merge boolean(default true) - Whether to allow rebase merges for pull requests.
- template_repository NullableRepository? - A repository on GitHub.
- temp_clone_token string? -
- allow_squash_merge boolean(default true) - Whether to allow squash merges for pull requests.
- allow_auto_merge boolean(default false) - Whether to allow Auto-merge to be used on pull requests.
- delete_branch_on_merge boolean(default false) - Whether to delete head branches when pull requests are merged
- allow_merge_commit boolean(default true) - Whether to allow merge commits for pull requests.
- allow_forking boolean(default false) - Whether to allow forking this repo
- web_commit_signoff_required boolean(default false) - Whether to require contributors to sign off on web-based commits
- subscribers_count int? -
- network_count int? -
- open_issues int -
- watchers int -
- master_branch string? -
github: Teams_team_id_body
Fields
- name string - The name of the team.
- description string? - The description of the team.
- privacy "secret"|"closed" ? - The level of privacy this team should have. Editing teams without specifying this parameter leaves
privacy
intact. The options are:
For a non-nested team:secret
- only visible to organization owners and members of this team.closed
- visible to all members of this organization.
For a parent or child team:closed
- visible to all members of this organization.
- notification_setting "notifications_enabled"|"notifications_disabled" ? - The notification setting the team has chosen. Editing teams without specifying this parameter leaves
notification_setting
intact. The options are:notifications_enabled
- team members receive notifications when the team is @mentioned.notifications_disabled
- no one receives notifications.
- permission "pull"|"push"|"admin" (default "pull") - Deprecated. The permission that new repositories will be added to the team with when none is specified.
- parent_team_id int? - The ID of a team to set as the parent team.
github: Teams_team_slug_body
Fields
- name string? - The name of the team.
- description string? - The description of the team.
- privacy "secret"|"closed" ? - The level of privacy this team should have. Editing teams without specifying this parameter leaves
privacy
intact. When a team is nested, theprivacy
for parent teams cannot besecret
. The options are:
For a non-nested team:secret
- only visible to organization owners and members of this team.closed
- visible to all members of this organization.
For a parent or child team:closed
- visible to all members of this organization.
- notification_setting "notifications_enabled"|"notifications_disabled" ? - The notification setting the team has chosen. Editing teams without specifying this parameter leaves
notification_setting
intact. The options are:notifications_enabled
- team members receive notifications when the team is @mentioned.notifications_disabled
- no one receives notifications.
- permission "pull"|"push"|"admin" ? - Deprecated. The permission that new repositories will be added to the team with when none is specified.
- parent_team_id int? - The ID of a team to set as the parent team.
github: TeamSimple
Groups of organization members that gives permissions on specified repositories.
Fields
- id int - Unique identifier of the team
- node_id string -
- url string - URL for the team
- members_url string -
- name string - Name of the team
- description string - Description of the team
- permission string - Permission that the team will have for its repositories
- privacy string? - The level of privacy this team should have
- notification_setting string? - The notification setting the team has set
- html_url string -
- repositories_url string -
- slug string -
- ldap_dn string? - Distinguished Name (DN) that team maps to within LDAP environment
github: Template_repo_generate_body
Fields
- owner string? - The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.
- name string - The name of the new repository.
- description string? - A short description of the new repository.
- include_all_branches boolean(default false) - Set to
true
to include the directory structure and files from all branches in the template repository, and not just the default branch. Default:false
.
- 'private boolean(default false) - Either
true
to create a new private repository orfalse
to create a new public one.
github: Thread_id_subscription_body
Fields
- ignored boolean? - Whether to block all notifications from a thread.
github: ThreadSubscription
Thread Subscription
Fields
- subscribed boolean -
- ignored boolean -
- reason string -
- created_at string -
- url string -
- thread_url string? -
- repository_url string? -
github: TimelineAssignedIssueEvent
Timeline Assigned Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- assignee SimpleUser - A GitHub user.
github: TimelineCommentEvent
Timeline Comment Event
Fields
- event string -
- actor SimpleUser - A GitHub user.
- id int - Unique identifier of the issue comment
- node_id string -
- url string - URL for the issue comment
- body string? - Contents of the issue comment
- body_text string? -
- body_html string? -
- html_url string -
- user SimpleUser - A GitHub user.
- created_at string -
- updated_at string -
- issue_url string -
- author_association AuthorAssociation - How the author is associated with the repository.
- performed_via_github_app NullableIntegration? - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- reactions ReactionRollup? -
github: TimelineCommitCommentedEvent
Timeline Commit Commented Event
Fields
- event string? -
- node_id string? -
- commit_id string? -
- comments CommitComment[]? -
github: TimelineCommittedEvent
Timeline Committed Event
Fields
- event string? -
- sha string - SHA for the commit
- node_id string -
- url string -
- author Gitcommit_author - Identifying information for the git-user
- committer Gitcommit_author - Identifying information for the git-user
- message string - Message describing the purpose of the commit
- tree Gitcommit_tree -
- parents Gitcommit_parents[] -
- verification Gitcommit_verification -
- html_url string -
github: TimelineCrossReferencedEvent
Timeline Cross Referenced Event
Fields
- event string -
- actor SimpleUser? - A GitHub user.
- created_at string -
- updated_at string -
- 'source Timelinecrossreferencedevent_source -
github: Timelinecrossreferencedevent_source
Fields
- 'type string? -
- issue Issue? - Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
github: TimelineLineCommentedEvent
Timeline Line Commented Event
Fields
- event string? -
- node_id string? -
- comments PullRequestReviewComment[]? -
github: TimelineReviewedEvent
Timeline Reviewed Event
Fields
- event string -
- id int - Unique identifier of the review
- node_id string -
- user SimpleUser - A GitHub user.
- body string - The text of the review.
- state string -
- html_url string -
- pull_request_url string -
- _links Timelinereviewedevent__links -
- submitted_at string? -
- commit_id string - A commit SHA for the review.
- body_html string? -
- body_text string? -
- author_association AuthorAssociation - How the author is associated with the repository.
github: Timelinereviewedevent__links
Fields
- pull_request Timelinereviewedevent__links_html -
github: Timelinereviewedevent__links_html
Fields
- href string -
github: TimelineUnassignedIssueEvent
Timeline Unassigned Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- assignee SimpleUser - A GitHub user.
github: Token_scoped_body
Fields
- access_token string - The access token used to authenticate to the GitHub API.
- target string? - The name of the user or organization to scope the user access token to. Required unless
target_id
is specified.
- target_id int? - The ID of the user or organization to scope the user access token to. Required unless
target
is specified.
- repositories string[]? - The list of repository names to scope the user access token to.
repositories
may not be specified ifrepository_ids
is specified.
- repository_ids int[]? - The list of repository IDs to scope the user access token to.
repository_ids
may not be specified ifrepositories
is specified.
- permissions AppPermissions? - The permissions granted to the user access token.
github: Topic
A topic aggregates entities that are related to a subject.
Fields
- names string[] -
github: TopicSearchResultItem
Topic Search Result Item
Fields
- name string -
- display_name string -
- short_description string -
- description string -
- created_by string -
- released string -
- created_at string -
- updated_at string -
- featured boolean -
- curated boolean -
- score decimal -
- repository_count int? -
- logo_url string? -
- text_matches SearchResultTextMatches? -
- related Topicsearchresultitem_related[]? -
- aliases Topicsearchresultitem_related[]? -
github: Topicsearchresultitem_related
Fields
- topic_relation Topicsearchresultitem_topic_relation? -
github: Topicsearchresultitem_topic_relation
Fields
- id int? -
- name string? -
- topic_id int? -
- relation_type string? -
github: TopicSearchResultItemResponse
Topic Search Result Item
Fields
- total_count int -
- incomplete_results boolean -
- items TopicSearchResultItem[] -
github: Traffic
Fields
- timestamp string -
- uniques int -
- count int -
github: UnassignedIssueEvent
Unassigned Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- assignee SimpleUser - A GitHub user.
- assigner SimpleUser - A GitHub user.
github: UnlabeledIssueEvent
Unlabeled Issue Event
Fields
- id int -
- node_id string -
- url string -
- actor SimpleUser - A GitHub user.
- event string -
- commit_id string -
- commit_url string -
- created_at string -
- performed_via_github_app NullableIntegration - GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
- label Labeledissueevent_label -
github: User
Fields
- avatar_url string? -
- deleted boolean? -
- email string? -
- events_url string? -
- followers_url string? -
- following_url string? -
- gists_url string? -
- gravatar_id string? -
- html_url string? -
- id int -
- login string -
- name string? -
- node_id string? -
- organizations_url string? -
- received_events_url string? -
- repos_url string? -
- site_admin boolean? -
- starred_url string? -
- subscriptions_url string? -
- 'type "Bot"|"User"|"Organization" ? -
- url string? -
github: User_body
Fields
- name string? - The new name of the user.
- email string? - The publicly visible email address of the user.
- blog string? - The new blog URL of the user.
- twitter_username string? - The new Twitter username of the user.
- company string? - The new company of the user.
- location string? - The new location of the user.
- hireable boolean? - The new hiring availability of the user.
- bio string? - The new short biography of the user.
github: User_gpg_keys_body
Fields
- name string? - A descriptive name for the new key.
- armored_public_key string - A GPG key in ASCII-armored format.
github: User_keys_body
Fields
- title string? - A descriptive name for the new key.
- 'key string - The public SSH key to add to your GitHub account.
github: User_migrations_body
Fields
- lock_repositories boolean? - Lock the repositories being migrated at the start of the migration
- exclude_metadata boolean? - Indicates whether metadata should be excluded and only git source should be included for the migration.
- exclude_git_data boolean? - Indicates whether the repository git data should be excluded from the migration.
- exclude_attachments boolean? - Do not include attachments in the migration
- exclude_releases boolean? - Do not include releases in the migration
- exclude_owner_projects boolean? - Indicates whether projects owned by the organization or users should be excluded.
- org_metadata_only boolean(default false) - Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
- exclude ("repositories")[]? - Exclude attributes from the API response to improve performance
- repositories string[] -
github: User_projects_body
Fields
- name string - Name of the project
- body string? - Body of the project
github: User_repos_body
Fields
- name string - The name of the repository.
- description string? - A short description of the repository.
- homepage string? - A URL with more information about the repository.
- 'private boolean(default false) - Whether the repository is private.
- has_issues boolean(default true) - Whether issues are enabled.
- has_projects boolean(default true) - Whether projects are enabled.
- has_wiki boolean(default true) - Whether the wiki is enabled.
- has_discussions boolean(default false) - Whether discussions are enabled.
- team_id int? - The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.
- auto_init boolean(default false) - Whether the repository is initialized with a minimal README.
- gitignore_template string? - The desired language or platform to apply to the .gitignore.
- license_template string? - The license keyword of the open source license for this repository.
- allow_squash_merge boolean(default true) - Whether to allow squash merges for pull requests.
- allow_merge_commit boolean(default true) - Whether to allow merge commits for pull requests.
- allow_rebase_merge boolean(default true) - Whether to allow rebase merges for pull requests.
- allow_auto_merge boolean(default false) - Whether to allow Auto-merge to be used on pull requests.
- delete_branch_on_merge boolean(default false) - Whether to delete head branches when pull requests are merged
- squash_merge_commit_title "PR_TITLE"|"COMMIT_OR_PR_TITLE" ? - The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- squash_merge_commit_message "PR_BODY"|"COMMIT_MESSAGES"|"BLANK" ? - The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- merge_commit_title "PR_TITLE"|"MERGE_MESSAGE" ? - The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- merge_commit_message "PR_BODY"|"PR_TITLE"|"BLANK" ? - The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- has_downloads boolean(default true) - Whether downloads are enabled.
- is_template boolean(default false) - Whether this repository acts as a template that can be used to generate new repositories.
github: User_social_accounts_body
Fields
- account_urls string[] - Full URLs for the social media profiles to add.
github: User_social_accounts_body_1
Fields
- account_urls string[] - Full URLs for the social media profiles to delete.
github: User_ssh_signing_keys_body
Fields
- title string? - A descriptive name for the new key.
- 'key string - The public SSH key to add to your GitHub account. For more information, see "Checking for existing SSH keys."
github: Usercodespaces_pull_request
Pull request number for this codespace
Fields
- pull_request_number int - Pull request number
- repository_id int - Repository id for this codespace
github: UserMarketplacePurchase
User Marketplace Purchase
Fields
- billing_cycle string -
- next_billing_date string -
- unit_count int -
- on_free_trial boolean -
- free_trial_ends_on string -
- updated_at string -
- account MarketplaceAccount -
- plan MarketplaceListingPlan - Marketplace Listing Plan
github: UserSearchResultItem
User Search Result Item
Fields
- login string -
- id int -
- node_id string -
- avatar_url string -
- gravatar_id string -
- url string -
- html_url string -
- followers_url string -
- subscriptions_url string -
- organizations_url string -
- repos_url string -
- received_events_url string -
- 'type string -
- score decimal -
- following_url string -
- gists_url string -
- starred_url string -
- events_url string -
- public_repos int? -
- public_gists int? -
- followers int? -
- following int? -
- created_at string? -
- updated_at string? -
- name string? -
- bio string? -
- email string? -
- location string? -
- site_admin boolean -
- hireable boolean? -
- text_matches SearchResultTextMatches? -
- blog string? -
- company string? -
- suspended_at string? -
github: UserSearchResultItemResponse
User Search Result Item
Fields
- total_count int -
- incomplete_results boolean -
- items UserSearchResultItem[] -
github: ValidationError
Validation Error
Fields
- message string -
- documentation_url string -
- errors Validationerror_errors[]? -
github: Validationerror_errors
Fields
- 'resource string? -
- 'field string? -
- message string? -
- code string -
- index int? -
github: ValidationErrorSimple
Validation Error Simple
Fields
- message string -
- documentation_url string -
- errors string[]? -
github: Variables_name_body
Fields
- name string? - The name of the variable.
- value string? - The value of the variable.
- visibility "all"|"private"|"selected" ? - The type of repositories in the organization that can access the variable.
selected
means only the repositories specified byselected_repository_ids
can access the variable.
- selected_repository_ids int[]? - An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the
visibility
is set toselected
.
github: Variables_name_body_1
Fields
- name string? - The name of the variable.
- value string? - The value of the variable.
github: Variables_name_body_2
Fields
- name string? - The name of the variable.
- value string? - The value of the variable.
github: Verification
Fields
- verified boolean -
- reason string -
- payload string -
- signature string -
github: ViewTraffic
View Traffic
Fields
- count int -
- uniques int -
- views Traffic[] -
github: WebhookConfig
Configuration object of the webhook
Fields
- url WebhookConfigUrl? - The URL to which the payloads will be delivered.
- content_type WebhookConfigContentType? - The media type used to serialize the payloads. Supported values include
json
andform
. The default isform
.
- secret WebhookConfigSecret? - If provided, the
secret
will be used as thekey
to generate the HMAC hex digest value for delivery signature headers.
- insecure_ssl WebhookConfigInsecureSsl? -
github: Workflow
A GitHub Actions workflow
Fields
- id int -
- node_id string -
- name string -
- path string -
- state "active"|"deleted"|"disabled_fork"|"disabled_inactivity"|"disabled_manually" -
- created_at string -
- updated_at string -
- url string -
- html_url string -
- badge_url string -
- deleted_at string? -
github: Workflow_id_dispatches_body
Fields
- ref string - The git reference for the workflow. The reference can be a branch or tag name.
- inputs record {}? - Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when
inputs
are omitted.
github: WorkflowResponse
A GitHub Actions workflow
Fields
- total_count int -
- workflows Workflow[] -
github: WorkflowRun
An invocation of a workflow
Fields
- id int - The ID of the workflow run.
- name string? - The name of the workflow run.
- node_id string -
- check_suite_id int? - The ID of the associated check suite.
- check_suite_node_id string? - The node ID of the associated check suite.
- head_branch string -
- head_sha string - The SHA of the head commit that points to the version of the workflow being run.
- path string - The full path of the workflow
- run_number int - The auto incrementing run number for the workflow run.
- run_attempt int? - Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
- referenced_workflows ReferencedWorkflow[]? -
- event string -
- status string -
- conclusion string -
- workflow_id int - The ID of the parent workflow.
- url string - The URL to the workflow run.
- html_url string -
- pull_requests PullRequestMinimal[] - Pull requests that are open with a
head_sha
orhead_branch
that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.
- created_at string -
- updated_at string -
- actor SimpleUser? - A GitHub user.
- triggering_actor SimpleUser? - A GitHub user.
- run_started_at string? - The start time of the latest run. Resets on re-run.
- jobs_url string - The URL to the jobs for the workflow run.
- logs_url string - The URL to download the logs for the workflow run.
- check_suite_url string - The URL to the associated check suite.
- artifacts_url string - The URL to the artifacts for the workflow run.
- cancel_url string - The URL to cancel the workflow run.
- rerun_url string - The URL to rerun the workflow run.
- previous_attempt_url string? - The URL to the previous attempted run of this workflow, if one exists.
- workflow_url string - The URL to the workflow.
- head_commit NullableSimpleCommit - A commit.
- repository MinimalRepository - Minimal Repository
- head_repository MinimalRepository - Minimal Repository
- head_repository_id int? -
- display_title string - The event-specific title associated with the run or the run-name if set, or the value of
run-name
if it is set in the workflow.
github: WorkflowRunResponse
An invocation of a workflow
Fields
- total_count int -
- workflow_runs WorkflowRun[] -
github: WorkflowRunUsage
Workflow Run Usage
Fields
- billable Workflowrunusage_billable -
- run_duration_ms int? -
github: Workflowrunusage_billable
Fields
- UBUNTU Workflowrunusage_billable_UBUNTU? -
- MACOS Workflowrunusage_billable_UBUNTU? -
- WINDOWS Workflowrunusage_billable_UBUNTU? -
github: Workflowrunusage_billable_UBUNTU
Fields
- total_ms int -
- jobs int -
- job_runs Workflowrunusage_billable_UBUNTU_job_runs[]? -
github: Workflowrunusage_billable_UBUNTU_job_runs
Fields
- job_id int -
- duration_ms int -
github: WorkflowUsage
Workflow Usage
Fields
- billable Workflowusage_billable -
github: Workflowusage_billable
Fields
- UBUNTU Workflowusage_billable_UBUNTU? -
- MACOS Workflowusage_billable_UBUNTU? -
- WINDOWS Workflowusage_billable_UBUNTU? -
github: Workflowusage_billable_UBUNTU
Fields
- total_ms int? -
Union types
github: InteractionExpiry
InteractionExpiry
The duration of the interaction restriction. Default: one_day
.
github: CodeScanningAlertSeverity
CodeScanningAlertSeverity
Severity of a code scanning alert.
github: CodeScanningAlertClassification
CodeScanningAlertClassification
A classification of the file. For example to identify it as generated.
github: EnabledRepositories
EnabledRepositories
The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
github: User_codespaces_body
User_codespaces_body
github: CodeScanningAlertState
CodeScanningAlertState
State of a code scanning alert.
github: SecurityAdvisoryEcosystems
SecurityAdvisoryEcosystems
The package's language or package management ecosystem.
github: SecretScanningAlertResolution
SecretScanningAlertResolution
Required when the state
is resolved
. The reason for resolving the alert.
github: RepositoryRule
RepositoryRule
A repository rule.
github: SecretScanningAlertState
SecretScanningAlertState
Sets the state of the secret scanning alert. You must provide resolution
when you set the state to resolved
.
github: InteractionLimitResponseAny
InteractionLimitResponseAny
Interaction limit settings.
github: UserResponse
UserResponse
github: Repo_pages_body
Repo_pages_body
github: CodeScanningAlertSetState
CodeScanningAlertSetState
Sets the state of the code scanning alert. You must provide dismissed_reason
when you set the state to dismissed
.
github: AllowedActions
AllowedActions
The permissions policy that controls the actions and reusable workflows that are allowed to run.
github: Run_id_deployment_protection_rule_body
Run_id_deployment_protection_rule_body
github: RepositoryRuleEnforcement
RepositoryRuleEnforcement
The enforcement level of the ruleset. evaluate
allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (evaluate
is only available with GitHub Enterprise).
github: Checkruns_check_run_id_body
Checkruns_check_run_id_body
github: Required_status_checks_contexts_body
Required_status_checks_contexts_body
github: DeploymentReviewerType
DeploymentReviewerType
The type of reviewer.
github: StarredRepositoryResponse
StarredRepositoryResponse
Starred Repository
github: InteractionGroup
InteractionGroup
The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
github: Issue_number_labels_body_1
Issue_number_labels_body_1
github: Issue_number_labels_body
Issue_number_labels_body
github: Required_status_checks_contexts_body_1
Required_status_checks_contexts_body_1
github: Required_status_checks_contexts_body_2
Required_status_checks_contexts_body_2
github: SecurityAdvisoryCreditTypes
SecurityAdvisoryCreditTypes
The type of credit the user is receiving.
github: Inline_response_200
Inline_response_200
github: CodeScanningAlertDismissedReason
CodeScanningAlertDismissedReason
Required when the state is dismissed. The reason for dismissing or closing the alert.
github: Inline_response_422
Inline_response_422
github: Repo_pages_body_1
Repo_pages_body_1
The source branch and directory used to publish your Pages site.
github: Repo_checkruns_body
Repo_checkruns_body
github: IssueEventForIssue
IssueEventForIssue
Issue Event for Issue
github: CodeScanningAlertStateQuery
CodeScanningAlertStateQuery
State of a code scanning alert.
github: Pull_number_requested_reviewers_body
Pull_number_requested_reviewers_body
github: TimelineIssueEvents
TimelineIssueEvents
Timeline Event
github: StargazerResponse
StargazerResponse
Stargazer
github: RepositoryRuleDetailed
RepositoryRuleDetailed
A repository rule with ruleset details.
github: ActionsDefaultWorkflowPermissions
ActionsDefaultWorkflowPermissions
The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
github: ProjectsV2ItemContentType
ProjectsV2ItemContentType
The type of content tracked in a project item
github: OrgRulesetConditions
OrgRulesetConditions
Conditions for an organization ruleset. The conditions object should contain both repository_name
and ref_name
properties or both repository_id
and ref_name
properties.
github: AuthorAssociation
AuthorAssociation
How the author is associated with the repository.
Array types
github: GlobalAdvisoryArr
GlobalAdvisoryArr
github: HookDeliveryItemArr
HookDeliveryItemArr
github: IntegrationInstallationRequestArr
IntegrationInstallationRequestArr
github: InstallationArr
InstallationArr
github: ClassroomAcceptedAssignmentArr
ClassroomAcceptedAssignmentArr
github: ClassroomAssignmentGradeArr
ClassroomAssignmentGradeArr
github: SimpleClassroomArr
SimpleClassroomArr
github: SimpleClassroomAssignmentArr
SimpleClassroomAssignmentArr
github: CodeOfConductArr
CodeOfConductArr
github: DependabotAlertWithRepositoryArr
DependabotAlertWithRepositoryArr
github: OrganizationSecretScanningAlertArr
OrganizationSecretScanningAlertArr
github: EventArr
EventArr
github: BaseGistArr
BaseGistArr
github: GistCommentArr
GistCommentArr
github: GistCommitArr
GistCommitArr
github: GistSimpleArr
GistSimpleArr
github: StringArr
StringArr
github: IssueArr
IssueArr
github: LicenseSimpleArr
LicenseSimpleArr
github: MarketplaceListingPlanArr
MarketplaceListingPlanArr
github: MarketplacePurchaseArr
MarketplacePurchaseArr
github: NotificationThreadArr
NotificationThreadArr
github: OrganizationSimpleArr
OrganizationSimpleArr
github: RunnerApplicationArr
RunnerApplicationArr
github: SimpleUserArr
SimpleUserArr
github: CodeScanningOrganizationAlertItemsArr
CodeScanningOrganizationAlertItemsArr
github: PackageArr
PackageArr
github: OrganizationInvitationArr
OrganizationInvitationArr
github: OrgHookArr
OrgHookArr
github: TeamArr
TeamArr
github: MigrationArr
MigrationArr
github: MinimalRepositoryArr
MinimalRepositoryArr
github: PackageVersionArr
PackageVersionArr
github: OrganizationProgrammaticAccessGrantRequestArr
OrganizationProgrammaticAccessGrantRequestArr
github: OrganizationProgrammaticAccessGrantArr
OrganizationProgrammaticAccessGrantArr
github: ProjectArr
ProjectArr
github: RepositoryRulesetArr
RepositoryRulesetArr
github: RepositoryAdvisoryArr
RepositoryAdvisoryArr
github: TeamSimpleArr
TeamSimpleArr
github: TeamDiscussionArr
TeamDiscussionArr
github: TeamDiscussionCommentArr
TeamDiscussionCommentArr
github: ReactionArr
ReactionArr
github: TeamProjectArr
TeamProjectArr
github: ProjectCardArr
ProjectCardArr
github: ProjectColumnArr
ProjectColumnArr
github: EnvironmentApprovalsArr
EnvironmentApprovalsArr
github: PendingDeploymentArr
PendingDeploymentArr
github: DeploymentArr
DeploymentArr
github: ActivityArr
ActivityArr
github: AutolinkArr
AutolinkArr
github: ShortBranchArr
ShortBranchArr
github: IntegrationArr
IntegrationArr
github: CheckAnnotationArr
CheckAnnotationArr
github: CodeScanningAlertItemsArr
CodeScanningAlertItemsArr
github: CodeScanningAlertInstanceArr
CodeScanningAlertInstanceArr
github: CodeScanningAnalysisArr
CodeScanningAnalysisArr
github: CodeScanningCodeqlDatabaseArr
CodeScanningCodeqlDatabaseArr
github: CollaboratorArr
CollaboratorArr
github: CommitCommentArr
CommitCommentArr
github: CommitArr
CommitArr
github: BranchShortArr
BranchShortArr
github: PullRequestSimpleArr
PullRequestSimpleArr
github: StatusArr
StatusArr
github: ContentTreeArr
ContentTreeArr
github: ContributorArr
ContributorArr
github: DependabotAlertArr
DependabotAlertArr
github: DeploymentStatusArr
DeploymentStatusArr
github: GitRefArr
GitRefArr
github: HookArr
HookArr
github: PorterAuthorArr
PorterAuthorArr
github: PorterLargeFileArr
PorterLargeFileArr
github: RepositoryInvitationArr
RepositoryInvitationArr
github: IssueCommentArr
IssueCommentArr
github: IssueEventArr
IssueEventArr
github: IssueEventForIssueArr
IssueEventForIssueArr
github: LabelArr
LabelArr
github: TimelineIssueEventsArr
TimelineIssueEventsArr
github: DeployKeyArr
DeployKeyArr
github: MilestoneArr
MilestoneArr
github: PageBuildArr
PageBuildArr
github: PullRequestReviewCommentArr
PullRequestReviewCommentArr
github: DiffEntryArr
DiffEntryArr
github: PullRequestReviewArr
PullRequestReviewArr
github: ReviewCommentArr
ReviewCommentArr
github: ReleaseArr
ReleaseArr
github: ReleaseAssetArr
ReleaseAssetArr
github: RepositoryRuleDetailedArr
RepositoryRuleDetailedArr
github: SecretScanningAlertArr
SecretScanningAlertArr
github: SecretScanningLocationArr
SecretScanningLocationArr
github: CodeFrequencyStatArr
CodeFrequencyStatArr
github: CommitActivityArr
CommitActivityArr
github: ContributorActivityArr
ContributorActivityArr
github: TagArr
TagArr
github: TagProtectionArr
TagProtectionArr
github: ContentTrafficArr
ContentTrafficArr
github: ReferrerTrafficArr
ReferrerTrafficArr
github: EmailArr
EmailArr
github: GpgKeyArr
GpgKeyArr
github: KeyArr
KeyArr
github: UserMarketplacePurchaseArr
UserMarketplacePurchaseArr
github: OrgMembershipArr
OrgMembershipArr
github: RepositoryArr
RepositoryArr
github: SocialAccountArr
SocialAccountArr
github: SshSigningKeyArr
SshSigningKeyArr
github: TeamFullArr
TeamFullArr
github: KeySimpleArr
KeySimpleArr
github: DependencyGraphDiff
DependencyGraphDiff
A diff of the dependencies between two commits.
github: RuleSuites
RuleSuites
Response
github: ContentDirectory
ContentDirectory
A list of directory items
github: CodeFrequencyStat
CodeFrequencyStat
Code Frequency Stat
github: SearchResultTextMatches
SearchResultTextMatches
Integer types
Import
import ballerinax/github;
Metadata
Released date: 5 months ago
Version: 5.0.2
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.8.4
GraalVM compatible: Yes
Pull count
Total: 298
Current verison: 2
Weekly downloads
Keywords
IT Operations/Source Control
Cost/Freemium
Contributors