The identity and technical contract details declared by the specification.
installation
object
Installation
20 properties
17 required
scim-error
object
Scim Error
6 properties
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
simple-user
object
A GitHub user.
21 properties
18 required
validation-error
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…
basic-error
object
Basic Error
4 properties
webhook-config-url
string
The URL to which the payloads will be delivered.
webhook-config-insecure-ssl
integration
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
environment-approvals
object
An entry in the reviews log for environment deployments
4 properties
4 required
app-permissions
object
The permissions granted to the user access token.
45 properties
application-grant
object
The authorization associated with an OAuth Access.
7 properties
6 required
hook-delivery
object
Delivery made by a webhook.
14 properties
13 required
enterprise
object
An enterprise on GitHub.
10 properties
8 required
nullable-simple-user
objectnull
A GitHub user.
21 properties
18 required
webhook-config
object
Configuration object of the webhook
4 properties
nullable-scoped-installation
objectnull
7 properties
5 required
authorization
object
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
15 properties
13 required
code-of-conduct
object
Code Of Conduct
5 properties
4 required
link-with-type
object
Hypermedia Link with Type
2 properties
2 required
feed
object
Feed
11 properties
3 required
gist-comment
object
A comment made to a gist.
8 properties
8 required
gist-simple
object
Gist Simple
21 properties
author-association
string
How the author is associated with the repository.
public-user
object
Public User
39 properties
31 required
gist-history
object
Gist History
5 properties
gitignore-template
object
Gitignore Template
2 properties
2 required
license
object
License
13 properties
13 required
ghes-replication-status-indicator
string
ghes-replication-status
object
2 properties
ghes-config-nodes
object
2 properties
ghes-cluster-topology
string
api-overview
object
Api Overview
5 properties
1 required
thread
object
Thread
9 properties
9 required
minimal-repository
object
Minimal Repository
87 properties
46 required
security-and-analysis
objectnull
3 properties
thread-subscription
object
Thread Subscription
7 properties
5 required
team-organization
object
Team Organization
48 properties
23 required
dependabot-public-key
object
The public key used for setting Dependabot Secrets.
2 properties
2 required
package
object
A software package
11 properties
9 required
allowed-actions
string
The permissions policy that controls the actions that are allowed to run.
actions-organization-permissions
object
4 properties
1 required
selected-actions
object
2 properties
2 required
runner
object
A self hosted runner
7 properties
6 required
runner-label
object
A label for a self hosted runner
3 properties
1 required
audit-log-event
object
43 properties
org-pre-receive-hook
object
5 properties
team-discussion-comment
object
A reply to a discussion within a team.
13 properties
12 required
organization-custom-repository-role
object
Custom repository roles created by organization owners
8 properties
7 required
org-hook
object
Org Hook
11 properties
10 required
announcement-message
stringnull
The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs…
team-full
object
Groups of organization members that gives permissions on specified repositories.
18 properties
15 required
runner-groups-org
object
12 properties
7 required
package-version
object
A version of a software package
11 properties
6 required
actions-can-approve-pull-request-reviews
boolean
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
organization-actions-variable
object
Organization variable for GitHub Actions.
6 properties
5 required
team-discussion
object
A team discussion is a persistent record of a free-form conversation within a team.
18 properties
17 required
nullable-team-simple
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
organization-dependabot-secret
object
Secrets for GitHub Dependabot for an organization.
5 properties
4 required
nullable-license-simple
objectnull
License Simple
6 properties
5 required
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
announcement-banner
object
Announcement at either the repository, organization, or enterprise level
3 properties
3 required
announcement-expiration
stringnull
The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format: YYYY-MM-DDTHH:MM:SSZ. To set an an…
actions-default-workflow-permissions
string
The default workflow permissions granted to the GITHUBTOKEN when running workflows.
organization-simple
object
A GitHub organization.
12 properties
12 required
enabled-repositories
string
The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
team-membership
object
Team Membership
3 properties
3 required
reaction-rollup
object
10 properties
10 required
actions-cache-usage-org-enterprise
object
2 properties
2 required
advanced-security-active-committers-user
object
2 properties
2 required
organization-actions-secret
object
Secrets for GitHub Actions for an organization.
5 properties
4 required
nullable-minimal-repository
objectnull
Minimal Repository
87 properties
46 required
announcement-user-dismissible
booleannull
Whether an announcement can be dismissed by the user.
advanced-security-active-committers
object
3 properties
1 required
repository
object
A repository on GitHub.
95 properties
73 required
external-group
object
Information about an external group's usage and its members
5 properties
4 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.
organization-full
object
Organization Full
56 properties
23 required
oidc-custom-sub
object
Actions OIDC Subject customization
1 property
1 required
migration
object
A migration.
18 properties
16 required
org-membership
object
Org Membership
7 properties
6 required
advanced-security-active-committers-repository
object
3 properties
3 required
project-card
object
Project cards represent a scope of work.
13 properties
9 required
project-column
object
Project columns contain cards of work.
8 properties
8 required
project-collaborator-permission
object
Project Collaborator Permission
2 properties
2 required
project
object
Projects are a way to organize columns and cards of work.
15 properties
13 required
rate-limit
object
4 properties
4 required
rate-limit-overview
object
Rate Limit Overview
2 properties
2 required
pending-deployment
object
Details of a deployment that is waiting for protection rules to pass
5 properties
5 required
oidc-custom-sub-repo
object
Actions OIDC subject customization for a repository
2 properties
1 required
code-of-conduct_2
object
Code Of Conduct
5 properties
4 required
minimal-repository_2
object
Minimal Repository
87 properties
46 required
workflow-run
object
An invocation of a workflow
36 properties
26 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
actions-enabled
boolean
Whether GitHub Actions is enabled on the repository.
security-and-analysis_2
object
3 properties
scim-error_2
object
Scim Error
6 properties
simple-user_2
object
GitHub user.
21 properties
18 required
deployment-reviewer-type
string
The type of reviewer.
actions-secret
object
Set secrets for GitHub Actions.
3 properties
3 required
runner_2
object
self hosted runner
7 properties
6 required
referenced-workflow
object
workflow referenced/reused by the initial caller workflow
3 properties
2 required
runner-label_2
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
workflow
object
GitHub Actions workflow
11 properties
10 required
actions-variable
object
4 properties
4 required
actions-repository-permissions
object
3 properties
1 required
nullable-team-simple_2
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
job
object
Information of a job execution in a workflow run
23 properties
21 required
artifact
object
An artifact
11 properties
10 required
actions-cache-usage-policy-for-repository
object
GitHub Actions cache usage policy for repository.
1 property
1 required
nullable-simple-commit
object
commit.
6 properties
6 required
actions-cache-usage-by-repository
object
GitHub Actions Cache Usage by repository.
3 properties
3 required
autolink
object
An autolink reference.
4 properties
4 required
status-check-policy
object
Status Check Policy
5 properties
5 required
branch-with-protection
object
Branch With Protection
8 properties
6 required
protected-branch-required-status-check
object
Protected Branch Required Status Check
6 properties
2 required
team_2
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
branch-restriction-policy
object
Branch Restriction Policy
7 properties
7 required
diff-entry
object
Diff Entry
11 properties
9 required
commit
object
Commit
11 properties
9 required
nullable-git-user
object
Metaproperties for Git author/committer information.
3 properties
simple-user_3
object
GitHub user.
21 properties
18 required
protected-branch-pull-request-review
object
Protected Branch Pull Request Review
7 properties
2 required
verification
object
4 properties
4 required
branch-protection
object
Branch Protection
16 properties
protected-branch-admin-enforced
object
Protected Branch Admin Enforced
2 properties
2 required
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
nullable-team-simple_3
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
empty-object
object
An object without any properties.
nullable-simple-user_2
object
GitHub user.
21 properties
18 required
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-ref
string
The Git reference, formatted as refs/pull/ /merge, refs/pull/ /head, refs/heads/ or simply .
code-scanning-alert-state
string
State of a code scanning alert.
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-default-setup
object
Configuration for code scanning default setup.
4 properties
code-scanning-alert-instance
object
10 properties
alert-html-url
string
The GitHub URL of the alert resource.
code-scanning-analysis-environment
string
Identifies the variable values associated with the environment in which this analysis was performed.
alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-alert
object
15 properties
12 required
code-scanning-alert-rule
object
9 properties
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-analysis-tool-name
string
The name of the tool used to generate the code scanning analysis.
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…
alert-instances-url
string
The REST API URL for fetching the list of instances for an alert.
code-scanning-analysis-commit-sha
string
The SHA of the commit to which the analysis you are uploading relates.
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.
alert-dismissed-at
string
The time that the alert was dismissed 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.
nullable-simple-user_3
object
GitHub user.
21 properties
18 required
code-scanning-analysis-sarif-id
string
An identifier for the upload.
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-sarifs-status
object
3 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…
nullable-collaborator
object
Collaborator
22 properties
18 required
repository-collaborator-permission
object
Repository Collaborator Permission
3 properties
3 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_4
object
GitHub user.
21 properties
18 required
repository-pre-receive-hook
object
4 properties
scim-error_3
object
Scim Error
6 properties
hook-response
object
3 properties
3 required
validation-error_2
object
Validation Error
3 properties
2 required
hook
object
Webhooks for repositories.
13 properties
12 required
hook-delivery_2
object
Delivery made by a webhook.
15 properties
13 required
team_3
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties
9 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
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
issue-event-label
object
Issue Event Label
2 properties
2 required
repository_2
object
repository on GitHub.
95 properties
73 required
nullable-license-simple_2
object
License Simple
6 properties
5 required
issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
nullable-team-simple_4
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
issue-event-project-card
object
Issue Event Project Card
6 properties
5 required
issue-event
object
Issue Event
22 properties
8 required
nullable-simple-user_5
object
GitHub user.
21 properties
18 required
nullable-milestone
object
collection of related issues and pull requests.
16 properties
16 required
issue-event-dismissed-review
object
4 properties
3 required
pull-request-review-request
object
Pull Request Review Request
2 properties
2 required
link
object
Hypermedia Link
1 property
1 required
team_4
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
pull-request
object
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…
48 properties
42 required
simple-user_5
object
GitHub user.
21 properties
18 required
team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
nullable-team-simple_5
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
auto-merge
object
The status of auto merging a pull request.
4 properties
4 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
pull-request-review
object
Pull Request Reviews are reviews on pull requests.
13 properties
10 required
nullable-simple-user_6
object
GitHub user.
21 properties
18 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
repository-subscription
object
Repository invitations let you manage who you collaborate with.
6 properties
6 required
git-tree
object
The hierarchy between files in a Git repository.
4 properties
4 required
participation-stats
object
2 properties
2 required
check-suite
object
suite of checks performed on the code of a given code change
19 properties
17 required
wait-timer
integer
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).
code-frequency-stat
array
Code Frequency Stat
deployment-simple
object
deployment created as the result of an Actions check run from a workflow that references an environment
14 properties
10 required
simple-commit
object
commit.
6 properties
6 required
pages-https-certificate
object
4 properties
3 required
content-file
object
Content File
14 properties
12 required
content-submodule
object
An object describing a submodule
11 properties
11 required
commit-activity
object
Commit Activity
3 properties
3 required
combined-commit-status
object
Combined Commit Status
7 properties
7 required
release
object
release.
22 properties
17 required
blob
object
Blob
7 properties
6 required
check-run
object
check performed on the code of a given code change
17 properties
16 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.
secret-scanning-alert-state
string
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
team_5
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
commit_2
object
Commit
11 properties
9 required
git-commit
object
Low-level Git commit operations within a repository
10 properties
10 required
validation-error_3
object
Validation Error
3 properties
2 required
release-asset
object
Data related to a release.
13 properties
13 required
page-build
object
Page Build
8 properties
8 required
nullable-team-simple_6
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
deployment-branch-policy
object
Details of a deployment branch policy.
3 properties
nullable-license-simple_4
object
License Simple
6 properties
5 required
nullable-repository
object
repository on GitHub.
95 properties
73 required
content-directory
array
list of directory items
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
label
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
7 properties
7 required
milestone
object
collection of related issues and pull requests.
16 properties
16 required
nullable-alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
dependency-graph-diff
array
diff of the dependencies between two commits.
deployment
object
request for a specific ref(branch,sha,tag) to be deployed
18 properties
14 required
environment
object
Details of a deployment environment
9 properties
7 required
topic
object
topic aggregates entities that are related to a subject.
1 property
1 required
installation_2
object
Installation
20 properties
17 required
git-ref
object
Git references within a repository
4 properties
4 required
git-tag
object
Metadata for a Git tag
8 properties
7 required
pages-source-hash
object
2 properties
2 required
simple-user_6
object
GitHub user.
21 properties
18 required
simple-commit-status
object
11 properties
10 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
page
object
The configuration for GitHub Pages for a repository.
12 properties
5 required
deploy-key
object
An SSH key granting access to a single repository.
9 properties
7 required
commit-comment
object
Commit Comment
14 properties
13 required
contributor-activity
object
Contributor Activity
3 properties
3 required
code-of-conduct-simple
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
object
Full Repository
102 properties
75 required
secret-scanning-alert
object
17 properties
enterprise_2
object
An enterprise on GitHub.
10 properties
8 required
deployment-status
object
The status of a deployment.
15 properties
11 required
deployment-branch-policy-settings
object
The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
2 properties
2 required
user-emails-response
array
The emails for the user.
user-role
array
The roles assigned to the user.
user-response
object
8 properties
3 required
scim-enterprise-user-response
scim-enterprise-group-response
user-name-response
object
4 properties
group-response
object
4 properties
1 required
meta
object
The metadata associated with the creation/updates to the user.
4 properties
1 required
maintenance-status
object
3 properties
ssh-key
object
2 properties
configuration-status
object
2 properties
enterprise-settings
object
2 properties
team_6
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GitHub publishes across the network.