GitHub Repos API is one of 384 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Repos. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
163 operations
across 95 paths,
and defines 93 schemas.
It is described by OpenAPI 3.0.3, at version 1.1.4.
Requests are made against a single base URL, {protocol}://{hostname}/api/v3.
The identity and technical contract details declared by the specification.
nullable-simple-user
object
A GitHub user.
21 properties
18 required
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
branch-short
object
Branch Short
3 properties
3 required
protected-branch-pull-request-review
object
Protected Branch Pull Request Review
7 properties
2 required
commit-activity
object
Commit Activity
3 properties
3 required
repository
object
A repository on GitHub.
95 properties
73 required
pages-https-certificate
object
4 properties
3 required
nullable-milestone
object
A collection of related issues and pull requests.
16 properties
16 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…
code-of-conduct-simple
object
Code of Conduct Simple
4 properties
4 required
full-repository
object
Full Repository
102 properties
75 required
contributor-activity
object
Contributor Activity
3 properties
3 required
page
object
The configuration for GitHub Pages for a repository.
12 properties
5 required
reaction-rollup
object
10 properties
10 required
deployment-branch-policy-name-pattern
object
1 property
1 required
content-file
object
Content File
14 properties
12 required
code-frequency-stat
array
Code Frequency Stat
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
page-build
object
Page Build
8 properties
8 required
deploy-key
object
An SSH key granting access to a single repository.
9 properties
7 required
link
object
Hypermedia Link
1 property
1 required
security-and-analysis
object
3 properties
deployment-status
object
The status of a deployment.
15 properties
11 required
branch-protection
object
Branch Protection
16 properties
status
object
The status of a commit.
11 properties
11 required
pull-request-simple
object
Pull Request Simple
36 properties
31 required
protected-branch-admin-enforced
object
Protected Branch Admin Enforced
2 properties
2 required
code-of-conduct
object
Code Of Conduct
5 properties
4 required
file-commit
object
File Commit
2 properties
2 required
basic-error
object
Basic Error
4 properties
participation-stats
object
2 properties
2 required
combined-commit-status
object
Combined Commit Status
7 properties
7 required
scim-error
object
Scim Error
6 properties
content-submodule
object
An object describing a submodule
11 properties
11 required
minimal-repository
object
Minimal Repository
87 properties
46 required
collaborator
object
Collaborator
22 properties
18 required
tag-protection
object
Tag protection
5 properties
1 required
webhook-config
object
Configuration object of the webhook
4 properties
page-deployment
object
The GitHub Pages deployment status.
3 properties
2 required
nullable-repository
object
A repository on GitHub.
95 properties
73 required
repository-invitation
object
Repository invitations let you manage who you collaborate with.
10 properties
9 required
deployment-branch-policy-name-pattern-with-type
object
1 property
1 required
commit-comparison
object
Commit Comparison
13 properties
12 required
deployment-branch-policy
object
Details of a deployment branch policy.
3 properties
commit-comment
object
Commit Comment
14 properties
13 required
auto-merge
object
The status of auto merging a pull request.
4 properties
4 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
deployment
object
A request for a specific ref(branch,sha,tag) to be deployed
18 properties
14 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).
short-branch
object
Short Branch
5 properties
3 required
status-check-policy
object
Status Check Policy
5 properties
5 required
hook-delivery
object
Delivery made by a webhook.
14 properties
13 required
release
object
A release.
22 properties
17 required
release-asset
object
Data related to a release.
13 properties
13 required
codeowners-errors
object
A list of errors found in a repo's CODEOWNERS file
1 property
1 required
validation-error
object
Validation Error
3 properties
2 required
nullable-collaborator
object
Collaborator
22 properties
18 required
protected-branch-required-status-check
object
Protected Branch Required Status Check
6 properties
2 required
validation-error-simple
object
Validation Error Simple
3 properties
2 required
pages-source-hash
object
2 properties
2 required
topic
object
A topic aggregates entities that are related to a subject.
1 property
1 required
deployment-reviewer-type
string
The type of reviewer.
contributor
object
Contributor
21 properties
2 required
branch-restriction-policy
object
Branch Restriction Policy
7 properties
7 required
content-tree
object
Content Tree
11 properties
12 required
merged-upstream
object
Results of a successful merge upstream request
3 properties
hook
object
Webhooks for repositories.
13 properties
12 required
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
release-notes-content
object
Generated name and body describing a release
2 properties
2 required
repository-collaborator-permission
object
Repository Collaborator Permission
3 properties
3 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
content-directory
array
A list of directory items
diff-entry
object
Diff Entry
11 properties
9 required
protected-branch
object
Branch protections protect branches
13 properties
1 required
autolink
object
An autolink reference.
4 properties
4 required
hook-delivery-item
object
Delivery made by a webhook, without request and response information.
11 properties
11 required
hook-response
object
3 properties
3 required
environment
object
Details of a deployment environment
9 properties
7 required
simple-user
object
A GitHub user.
21 properties
18 required
tag
object
Tag
5 properties
5 required
webhook-config-url
string
The URL to which the payloads will be delivered.
verification
object
4 properties
4 required
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
branch-with-protection
object
Branch With Protection
8 properties
6 required
page-build-status
object
Page Build Status
2 properties
2 required
commit
object
Commit
11 properties
9 required
content-symlink
object
An object describing a symlink
11 properties
11 required
nullable-license-simple
object
License Simple
6 properties
5 required
author-association
string
How the author is associated with the repository.
webhook-config-insecure-ssl
simple-commit-status
object
11 properties
10 required
nullable-git-user
object
Metaproperties for Git author/committer information.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GitHub publishes across the network.