The identity and technical contract details declared by the specification.
installation
object
Installation
20 properties
17 required
simple-user
object
A GitHub user.
21 properties
18 required
repository
object
A repository on GitHub.
95 properties
73 required
basic-error
object
Basic Error
4 properties
nullable-simple-user
objectnull
A GitHub user.
21 properties
18 required
app-permissions
object
The permissions granted to the user access token.
45 properties
enterprise
object
An enterprise on GitHub.
10 properties
8 required
nullable-license-simple
objectnull
License Simple
6 properties
5 required
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties
9 required
nullable-integration
objectnull
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…
17 properties
11 required
issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
actor
object
Actor
6 properties
5 required
reaction-rollup
object
10 properties
10 required
event
object
Event
8 properties
7 required
author-association
string
How the author is associated with the repository.
nullable-milestone
objectnull
A collection of related issues and pull requests.
16 properties
16 required
nullable-repository
objectnull
A repository on GitHub.
95 properties
73 required
organization-custom-repository-role-update-schema
object
4 properties
code-of-conduct
object
Code Of Conduct
5 properties
4 required
minimal-repository
object
Minimal Repository
87 properties
46 required
security-and-analysis
objectnull
3 properties
validation-error
object
Validation Error
3 properties
2 required
repository-fine-grained-permission
object
A fine-grained permission that protects repository resources.
2 properties
2 required
organization-custom-repository-role-create-schema
object
4 properties
3 required
code-of-conduct-simple
object
Code of Conduct Simple
4 properties
4 required
team-repository
object
A team's access to a repository.
89 properties
73 required
full-repository
object
Full Repository
102 properties
75 required
organization-custom-repository-role
object
Custom repository roles created by organization owners
8 properties
7 required
actions-cache-usage-by-repository
object
GitHub Actions Cache Usage by repository.
3 properties
3 required
validation-error-simple
object
Validation Error Simple
3 properties
2 required
project
object
Projects are a way to organize columns and cards of work.
15 properties
13 required
workflow-run
object
An invocation of a workflow
36 properties
26 required
actions-secret
object
Set secrets for GitHub Actions.
3 properties
3 required
allowed-actions
string
The permissions policy that controls the actions that are allowed to run.
selected-actions
object
2 properties
2 required
runner
object
self hosted runner
7 properties
6 required
runner-label
object
label for a self hosted runner
3 properties
1 required
actions-workflow-access-to-repository
object
1 property
1 required
pull-request-minimal
object
5 properties
5 required
authentication-token
object
Authentication Token
6 properties
2 required
actions-enabled
boolean
Whether GitHub Actions is enabled on the repository.
scim-error
object
Scim Error
6 properties
actions-can-approve-pull-request-reviews
boolean
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
actions-cache-list
object
Repository actions caches
2 properties
2 required
empty-object
object
An object without any properties.
nullable-simple-commit
object
commit.
6 properties
6 required
nullable-license-simple_2
object
License Simple
6 properties
5 required
actions-set-default-workflow-permissions
object
2 properties
actions-public-key
object
The public key used for setting Actions Secrets.
6 properties
2 required
actions-get-default-workflow-permissions
object
2 properties
2 required
code-of-conduct_2
object
Code Of Conduct
5 properties
4 required
minimal-repository_2
object
Minimal Repository
87 properties
46 required
security-and-analysis_2
object
3 properties
actions-default-workflow-permissions
string
The default workflow permissions granted to the GITHUBTOKEN when running workflows.
referenced-workflow
object
workflow referenced/reused by the initial caller workflow
3 properties
2 required
workflow
object
GitHub Actions workflow
11 properties
10 required
actions-repository-permissions
object
3 properties
1 required
runner-application
object
Runner Application
6 properties
4 required
actions-cache-usage-policy-for-repository
object
GitHub Actions cache usage policy for repository.
1 property
1 required
oidc-custom-sub-repo
object
Actions OIDC subject customization for a repository
2 properties
1 required
simple-user_2
object
GitHub user.
21 properties
18 required
repository_2
object
repository on GitHub.
95 properties
73 required
selected-actions-url
string
The API URL to use to get or set the actions that are allowed to run, when allowedactions is set to selected.
actions-variable
object
4 properties
4 required
artifact
object
An artifact
11 properties
10 required
validation-error_2
object
Validation Error
3 properties
2 required
autolink
object
An autolink reference.
4 properties
4 required
code-scanning-ref
string
The Git reference, formatted as refs/pull/ /merge, refs/pull/ /head, refs/heads/ or simply .
code-scanning-analysis-analysis-key
string
Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
code-scanning-alert-state
string
State of a code scanning alert.
code-scanning-alert-items
object
15 properties
12 required
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-alert-instance
object
10 properties
code-scanning-analysis-environment
string
Identifies the variable values associated with the environment in which this analysis was performed.
code-scanning-alert-severity
string
Severity of a code scanning alert.
alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
alert-html-url
string
The GitHub URL of the alert resource.
code-scanning-analysis-tool-guid
string
The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
code-scanning-alert-rule-summary
object
6 properties
code-scanning-alert-state-query
string
State of a code scanning alert.
code-scanning-analysis-commit-sha
string
The SHA of the commit to which the analysis you are uploading relates.
code-scanning-analysis-category
string
Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed o…
code-scanning-analysis-tool-name
string
The name of the tool used to generate the code scanning analysis.
alert-instances-url
string
The REST API URL for fetching the list of instances for an alert.
alert-number
integer
The security alert number.
code-scanning-analysis-created-at
string
The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
alert-fixed-at
string
The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-analysis-tool-version
string
The version of the tool used to generate the code scanning analysis.
code-scanning-analysis-deletion
object
Successful deletion of a code scanning analysis
2 properties
2 required
alert-dismissed-at
string
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-analysis-sarif-id
string
An identifier for the upload.
nullable-simple-user_2
object
GitHub user.
21 properties
18 required
code-scanning-analysis
object
15 properties
14 required
code-scanning-alert-location
object
Describe a region within a file for the alert.
5 properties
code-scanning-analysis-url
string
The REST API URL of the analysis resource.
code-scanning-analysis-tool
object
3 properties
code-scanning-alert-dismissed-comment
string
The dismissal comment associated with the dismissal of the alert.
code-scanning-alert-dismissed-reason
string
Required when the state is dismissed. The reason for dismissing or closing the alert.
alert-url
string
The REST API URL of the alert resource.
code-scanning-alert-classification
string
classification of the file. For example to identify it as generated.
code-scanning-alert-environment
string
Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language tha…
collaborator
object
Collaborator
22 properties
18 required
nullable-collaborator
object
Collaborator
22 properties
18 required
repository-collaborator-permission
object
Repository Collaborator Permission
3 properties
3 required
validation-error_3
object
Validation Error
3 properties
2 required
dependabot-public-key
object
The public key used for setting Dependabot Secrets.
2 properties
2 required
dependabot-alert-package
object
Details for the vulnerable package.
2 properties
2 required
alert-auto-dismissed-at
string
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
dependabot-secret
object
Set secrets for Dependabot.
3 properties
3 required
dependabot-alert-security-vulnerability
object
Details pertaining to one vulnerable version range for the advisory.
4 properties
4 required
dependabot-alert-security-advisory
object
Details for the GitHub Security Advisory.
13 properties
13 required
dependabot-alert
object
Dependabot alert.
15 properties
14 required
nullable-simple-user_3
object
GitHub user.
21 properties
18 required
repository-pre-receive-hook
object
4 properties
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
hook-response
object
3 properties
3 required
validation-error_4
object
Validation Error
3 properties
2 required
webhook-config-secret
string
If provided, the secret will be used as the key to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-serve…
hook
object
Webhooks for repositories.
13 properties
12 required
webhook-config-insecure-ssl
hook-delivery-item
object
Delivery made by a webhook, without request and response information.
12 properties
11 required
hook-delivery
object
Delivery made by a webhook.
15 properties
13 required
webhook-config-url
string
The URL to which the payloads will be delivered.
webhook-config
object
Configuration object of the webhook
4 properties
simple-user_3
object
GitHub user.
21 properties
18 required
code-of-conduct_3
object
Code Of Conduct
5 properties
4 required
minimal-repository_3
object
Minimal Repository
87 properties
46 required
security-and-analysis_3
object
3 properties
nullable-simple-user_4
object
GitHub user.
21 properties
18 required
repository-invitation
object
Repository invitations let you manage who you collaborate with.
10 properties
9 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
issue-event-rename
object
Issue Event Rename
2 properties
2 required
nullable-issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
simple-user_4
object
GitHub user.
21 properties
18 required
issue-event-milestone
object
Issue Event Milestone
1 property
1 required
nullable-integration_2
object
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…
17 properties
11 required
repository_3
object
repository on GitHub.
95 properties
73 required
issue-event-label
object
Issue Event Label
2 properties
2 required
validation-error_5
object
Validation Error
3 properties
2 required
nullable-simple-user_5
object
GitHub user.
21 properties
18 required
issue_2
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
issue-event-project-card
object
Issue Event Project Card
6 properties
5 required
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
issue-event
object
Issue Event
22 properties
8 required
issue-event-dismissed-review
object
4 properties
3 required
nullable-milestone_2
object
collection of related issues and pull requests.
16 properties
16 required
nullable-license-simple_3
object
License Simple
6 properties
5 required
nullable-simple-user_6
object
GitHub user.
21 properties
18 required
project_2
object
Projects are a way to organize columns and cards of work.
15 properties
13 required
simple-user_5
object
GitHub user.
21 properties
18 required
pull-request-review-comment
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties
16 required
repository-subscription
object
Repository invitations let you manage who you collaborate with.
6 properties
6 required
thread
object
Thread
9 properties
9 required
tag-protection
object
Tag protection
5 properties
1 required
metadata
object
User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
content-file
object
Content File
14 properties
12 required
repo-search-result-item
object
Repo Search Result Item
89 properties
74 required
content-submodule
object
An object describing a submodule
11 properties
11 required
tag
object
Tag
5 properties
5 required
content-tree
object
Content Tree
11 properties
12 required
nullable-simple-user_7
object
GitHub user.
21 properties
18 required
secret-scanning-alert-resolution
string
Required when the state is resolved. The reason for resolving the alert.
snapshot
object
Create a new snapshot of a repository's dependencies.
8 properties
6 required
secret-scanning-alert-state
string
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
validation-error_6
object
Validation Error
3 properties
2 required
dependency
object
5 properties
event_2
object
Event
8 properties
7 required
manifest
object
4 properties
1 required
nullable-license-simple_4
object
License Simple
6 properties
5 required
nullable-repository_2
object
repository on GitHub.
95 properties
73 required
content-directory
array
list of directory items
code-of-conduct_4
object
Code Of Conduct
5 properties
4 required
minimal-repository_4
object
Minimal Repository
87 properties
46 required
merged-upstream
object
Results of a successful merge upstream request
3 properties
security-and-analysis_4
object
3 properties
label
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
7 properties
7 required
nullable-alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
search-result-text-matches
array
actor_2
object
Actor
6 properties
5 required
topic
object
topic aggregates entities that are related to a subject.
1 property
1 required
nullable-milestone_3
object
collection of related issues and pull requests.
16 properties
16 required
installation_2
object
Installation
20 properties
17 required
dependency-graph-spdx-sbom
object
schema for the SPDX JSON format returned by the Dependency Graph.
1 property
1 required
simple-user_6
object
GitHub user.
21 properties
18 required
repository_4
object
repository on GitHub.
95 properties
73 required
nullable-integration_3
object
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…
17 properties
11 required
contributor
object
Contributor
21 properties
2 required
commit-comment
object
Commit Comment
14 properties
13 required
code-of-conduct-simple_2
object
Code of Conduct Simple
4 properties
4 required
license-content
object
License Content
13 properties
13 required
content-symlink
object
An object describing a symlink
11 properties
11 required
full-repository_2
object
Full Repository
102 properties
75 required
secret-scanning-alert
object
17 properties
check-suite-preference
object
Check suite configuration preferences for a repository.
2 properties
2 required
enterprise_2
object
An enterprise on GitHub.
10 properties
8 required
issue_3
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
team_2
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
nullable-team-simple_2
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GitHub publishes across the network.