GitHub: Repos schemas (part 1)
73 GitHub schemas with complete fields and constraints.
← Repos operations · All schemas
Check if Dependabot security updates are enabled for a repository — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Check Dependabot security updates |
enabled | boolean | Required within parent | Whether Dependabot security updates are enabled for the repository. |
paused | boolean | Required within parent | Whether Dependabot security updates are paused for the repository. |
Check if immutable releases are enabled for a repository — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Check immutable releases |
enabled | boolean | Required within parent | Whether immutable releases are enabled for the repository. |
enforced_by_owner | boolean | Required within parent | Whether immutable releases are enforced by the repository owner. |
Compare two commits — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Commit Comparison |
ahead_by | JSON | Required within parent | |
ahead_by (anyOf 1) | integer | Alternative | |
ahead_by (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
base_commit | Model | Required within parent | Expand Get a commit — response body |
behind_by | JSON | Required within parent | |
behind_by (anyOf 1) | integer | Alternative | |
behind_by (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
commits | array | Required within parent | |
commits[] | Model | Each item | Expand Get a commit — response body |
diff_url | string | Required within parent | Format: uri |
files | array | Optional | |
files[] | Model | Each item | Expand List pull requests files — response body — item |
html_url | string | Required within parent | Format: uri |
merge_base_commit | Model | Required within parent | Expand Get a commit — response body |
patch_url | string | Required within parent | Format: uri |
permalink_url | string | Required within parent | Format: uri |
status | string | Required within parent | Known values: diverged, ahead, behind, identical |
total_commits | JSON | Required within parent | |
total_commits (anyOf 1) | integer | Alternative | |
total_commits (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
url | string | Required within parent | Format: uri |
Referenced models: Get a commit — response body, List pull requests files — response body — item
Create a Git Hub Pages deployment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The GitHub Pages deployment status. |
id | JSON | Required within parent | The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | string | Alternative | |
page_url | string | Required within parent | The URI to the deployed GitHub Pages. Format: uri |
preview_url | string | Optional | The URI to the deployed GitHub Pages preview. Format: uri |
status_url | string | Required within parent | The URI to monitor GitHub Pages deployment status. Format: uri |
Create a commit status — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The status of a commit. |
avatar_url | JSON | Required within parent | |
avatar_url (anyOf 1) | string | Alternative | |
avatar_url (anyOf 2) | null | Alternative | |
context | string | Required within parent | |
created_at | string | Required within parent | |
creator | Model | Required within parent | Expand Get an issue — response body — user |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
state | string | Required within parent | |
target_url | JSON | Required within parent | |
target_url (anyOf 1) | string | Alternative | |
target_url (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | |
url | string | Required within parent |
Referenced models: Get an issue — response body — user
Create a deployment branch policy — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | 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 with `release/` and contain an additional single slash, use `release/*/*`. For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). |
type | string | Optional | Whether this rule targets a branch or tag One of: branch, tag |
Create a fork — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Full Repository |
allow_auto_merge | boolean | Optional | |
allow_forking | boolean | Optional | |
allow_merge_commit | boolean | Optional | |
allow_rebase_merge | boolean | Optional | |
allow_squash_merge | boolean | Optional | |
allow_update_branch | boolean | Optional | |
anonymous_access_enabled | boolean | Optional | Whether anonymous git access is allowed. Default: true |
archive_url | string | Required within parent | |
archived | boolean | Required within parent | |
assignees_url | string | Required within parent | |
blobs_url | string | Required within parent | |
branches_url | string | Required within parent | |
clone_url | string | Required within parent | |
code_of_conduct | Model | Optional | Expand Create a fork — response body — code of conduct |
collaborators_url | string | Required within parent | |
comments_url | string | Required within parent | |
commits_url | string | Required within parent | |
compare_url | string | Required within parent | |
contents_url | string | Required within parent | |
contributors_url | string | Required within parent | Format: uri |
created_at | string | Required within parent | Format: date-time |
custom_properties | object | Optional | The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. Additional keys: allowed |
default_branch | string | Required within parent | |
delete_branch_on_merge | boolean | Optional | |
deployments_url | string | Required within parent | Format: uri |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
disabled | boolean | Required within parent | Returns whether or not this repository disabled. |
downloads_url | string | Required within parent | Format: uri |
events_url | string | Required within parent | Format: uri |
fork | boolean | Required within parent | |
forks | JSON | Required within parent | |
forks (anyOf 1) | integer | Alternative | |
forks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forks_count | JSON | Required within parent | |
forks_count (anyOf 1) | integer | Alternative | |
forks_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forks_url | string | Required within parent | Format: uri |
full_name | string | Required within parent | |
git_commits_url | string | Required within parent | |
git_refs_url | string | Required within parent | |
git_tags_url | string | Required within parent | |
git_url | string | Required within parent | |
has_discussions | boolean | Required within parent | |
has_issues | boolean | Required within parent | |
has_pages | boolean | Required within parent | |
has_projects | boolean | Required within parent | |
has_pull_requests | boolean | Optional | |
has_wiki | boolean | Required within parent | |
homepage | JSON | Required within parent | |
homepage (anyOf 1) | string | Alternative | Format: uri |
homepage (anyOf 2) | null | Alternative | |
hooks_url | string | Required within parent | Format: uri |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
is_template | boolean | Optional | |
issue_comment_url | string | Required within parent | |
issue_events_url | string | Required within parent | |
issues_url | string | Required within parent | |
keys_url | string | Required within parent | |
labels_url | string | Required within parent | |
language | JSON | Required within parent | |
language (anyOf 1) | string | Alternative | |
language (anyOf 2) | null | Alternative | |
languages_url | string | Required within parent | Format: uri |
license | Model | Required within parent | Expand Create a fork — response body — license |
master_branch | string | Optional | |
merge_commit_message | string | Optional | 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. Known values: PR_BODY, PR_TITLE, BLANK |
merge_commit_title | string | Optional | 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). Known values: PR_TITLE, MERGE_MESSAGE |
merges_url | string | Required within parent | Format: uri |
milestones_url | string | Required within parent | |
mirror_url | JSON | Required within parent | |
mirror_url (anyOf 1) | string | Alternative | Format: uri |
mirror_url (anyOf 2) | null | Alternative | |
name | string | Required within parent | |
network_count | JSON | Required within parent | |
network_count (anyOf 1) | integer | Alternative | |
network_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
notifications_url | string | Required within parent | |
open_issues | JSON | Required within parent | |
open_issues (anyOf 1) | integer | Alternative | |
open_issues (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
open_issues_count | JSON | Required within parent | |
open_issues_count (anyOf 1) | integer | Alternative | |
open_issues_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
organization | Model | Optional | Expand Get an issue — response body — user |
owner | Model | Required within parent | Expand List users — response body — item |
parent | Model | Optional | Expand List repositories for the authenticated user — response body — item |
permissions | object | Optional | |
permissions.admin | boolean | Required within parent | |
permissions.maintain | boolean | Optional | |
permissions.pull | boolean | Required within parent | |
permissions.push | boolean | Required within parent | |
permissions.triage | boolean | Optional | |
private | boolean | Required within parent | |
pull_request_creation_policy | string | Optional | The policy controlling who can create pull requests: all or collaborators_only. Known values: all, collaborators_only |
pulls_url | string | Required within parent | |
pushed_at | string | Required within parent | Format: date-time |
releases_url | string | Required within parent | |
security_and_analysis | Model | Optional | Expand Create a fork — response body — security and analysis |
size | JSON | Required within parent | |
size (anyOf 1) | integer | Alternative | The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
source | Model | Optional | Expand List repositories for the authenticated user — response body — item |
squash_merge_commit_message | string | Optional | 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. Known values: PR_BODY, COMMIT_MESSAGES, BLANK |
squash_merge_commit_title | string | Optional | 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). Known values: PR_TITLE, COMMIT_OR_PR_TITLE |
ssh_url | string | Required within parent | |
stargazers_count | JSON | Required within parent | |
stargazers_count (anyOf 1) | integer | Alternative | |
stargazers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
stargazers_url | string | Required within parent | Format: uri |
statuses_url | string | Required within parent | |
subscribers_count | JSON | Required within parent | |
subscribers_count (anyOf 1) | integer | Alternative | |
subscribers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
subscribers_url | string | Required within parent | Format: uri |
subscription_url | string | Required within parent | Format: uri |
svn_url | string | Required within parent | Format: uri |
tags_url | string | Required within parent | Format: uri |
teams_url | string | Required within parent | Format: uri |
temp_clone_token | JSON | Optional | |
temp_clone_token (anyOf 1) | string | Alternative | When present and non-empty, a temporary credential for read-only Git access to this repository. It expires five minutes after generation and cannot be used to push changes. Treat this value as sensitive and avoid recording it in logs. |
temp_clone_token (anyOf 2) | null | Alternative | |
template_repository | Model | Optional | Expand Create a fork — response body — template repository |
topics | array | Optional | |
topics[] | string | Each item | |
trees_url | string | Required within parent | |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
visibility | string | Optional | The repository visibility: public, private, or internal. |
watchers | JSON | Required within parent | |
watchers (anyOf 1) | integer | Alternative | |
watchers (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
watchers_count | JSON | Required within parent | |
watchers_count (anyOf 1) | integer | Alternative | |
watchers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
web_commit_signoff_required | boolean | Optional |
Referenced models: Create a fork — response body — code of conduct, Create a fork — response body — license, Create a fork — response body — template repository, Get an issue — response body — user, List repositories for the authenticated user — response body — item, Create a fork — response body — security and analysis, List users — response body — item
Create a fork — response body — code of conduct
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Code of Conduct Simple |
html_url | JSON | Required within parent | |
html_url (anyOf 1) | string | Alternative | Format: uri |
html_url (anyOf 2) | null | Alternative | |
key | string | Required within parent | |
name | string | Required within parent | |
url | string | Required within parent | Format: uri |
Create a fork — response body — license
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | License Simple |
$ (anyOf 1).html_url | string | Optional | Format: uri |
$ (anyOf 1).key | string | Required within parent | |
$ (anyOf 1).name | string | Required within parent | |
$ (anyOf 1).node_id | string | Required within parent | |
$ (anyOf 1).spdx_id | JSON | Required within parent | |
$ (anyOf 1).spdx_id (anyOf 1) | string | Alternative | |
$ (anyOf 1).spdx_id (anyOf 2) | null | Alternative | |
$ (anyOf 1).url | JSON | Required within parent | |
$ (anyOf 1).url (anyOf 1) | string | Alternative | Format: uri |
$ (anyOf 1).url (anyOf 2) | null | Alternative | |
$ (anyOf 2) | null | Alternative |
Create a fork — response body — security and analysis
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1).advanced_security | object | Optional | Enable or disable GitHub Advanced Security for the repository. For standalone Code Scanning or Secret Protection products, this parameter cannot be used. |
$ (anyOf 1).advanced_security.status | string | Optional | Known values: enabled, disabled |
$ (anyOf 1).code_security | object | Optional | |
$ (anyOf 1).code_security.status | string | Optional | Known values: enabled, disabled |
$ (anyOf 1).dependabot_security_updates | object | Optional | Enable or disable Dependabot security updates for the repository. |
$ (anyOf 1).dependabot_security_updates.status | string | Optional | The enablement status of Dependabot security updates for the repository. Known values: enabled, disabled |
$ (anyOf 1).secret_scanning | object | Optional | |
$ (anyOf 1).secret_scanning.status | string | Optional | Known values: enabled, disabled |
$ (anyOf 1).secret_scanning_ai_detection | object | Optional | |
$ (anyOf 1).secret_scanning_ai_detection.status | string | Optional | Known values: enabled, disabled |
$ (anyOf 1).secret_scanning_delegated_alert_dismissal | object | Optional | |
$ (anyOf 1).secret_scanning_delegated_alert_dismissal.status | string | Optional | Known values: enabled, disabled |
$ (anyOf 1).secret_scanning_delegated_bypass | object | Optional | |
$ (anyOf 1).secret_scanning_delegated_bypass.status | string | Optional | Known values: enabled, disabled |
$ (anyOf 1).secret_scanning_delegated_bypass_options | object | Optional | |
$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers | array | Optional | The bypass reviewers for secret scanning delegated bypass |
$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[] | object | Each item | |
$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[].mode | string | Optional | The bypass mode for the reviewer Known values: ALWAYS, EXEMPT Default: ALWAYS |
$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[].reviewer_id | JSON | Required within parent | |
$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[].reviewer_id (anyOf 1) | integer | Alternative | The ID of the team or role selected as a bypass reviewer |
$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[].reviewer_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).secret_scanning_delegated_bypass_options.reviewers[].reviewer_type | string | Required within parent | The type of the bypass reviewer Known values: TEAM, ROLE |
$ (anyOf 1).secret_scanning_non_provider_patterns | object | Optional | |
$ (anyOf 1).secret_scanning_non_provider_patterns.status | string | Optional | Known values: enabled, disabled |
$ (anyOf 1).secret_scanning_push_protection | object | Optional | |
$ (anyOf 1).secret_scanning_push_protection.status | string | Optional | Known values: enabled, disabled |
$ (anyOf 2) | null | Alternative |
Create a fork — response body — template repository
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Create a fork — response body — template_repository / merge_commit_message: PR BODY, PR TITLE, BLANK, merge commit title: PR TITLE, MERGE MESSAGE, pull request creation policy: all, collaborators only, squash merge commit message: PR BODY, COMMIT MESSAGES, BLANK, squash merge commit title: PR TITLE, COMMIT OR PR TITLE |
$ (anyOf 2) | null | Alternative |
Create a fork — response body — template_repository / merge_commit_message: PR BODY, PR TITLE, BLANK, merge commit title: PR TITLE, MERGE MESSAGE, pull request creation policy: all, collaborators only, squash merge commit message: PR BODY, COMMIT MESSAGES, BLANK, squash merge commit title: PR TITLE, COMMIT OR PR TITLE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A repository on GitHub. |
allow_auto_merge | boolean | Optional | Whether to allow Auto-merge to be used on pull requests. Default: false |
allow_forking | boolean | Optional | Whether to allow forking this repo |
allow_merge_commit | boolean | Optional | Whether to allow merge commits for pull requests. Default: true |
allow_rebase_merge | boolean | Optional | Whether to allow rebase merges for pull requests. Default: true |
allow_squash_merge | boolean | Optional | Whether to allow squash merges for pull requests. Default: true |
allow_update_branch | boolean | Optional | 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. Default: false |
anonymous_access_enabled | boolean | Optional | Whether anonymous git access is enabled for this repository |
archive_url | string | Required within parent | |
archived | boolean | Required within parent | Whether the repository is archived. Default: false |
assignees_url | string | Required within parent | |
blobs_url | string | Required within parent | |
branches_url | string | Required within parent | |
clone_url | string | Required within parent | |
code_search_index_status | object | Optional | The status of the code search index for this repository |
code_search_index_status.lexical_commit_sha | string | Optional | |
code_search_index_status.lexical_search_ok | boolean | Optional | |
collaborators_url | string | Required within parent | |
comments_url | string | Required within parent | |
commits_url | string | Required within parent | |
compare_url | string | Required within parent | |
contents_url | string | Required within parent | |
contributors_url | string | Required within parent | Format: uri |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Format: date-time |
created_at (anyOf 2) | null | Alternative | |
default_branch | string | Required within parent | The default branch of the repository. |
delete_branch_on_merge | boolean | Optional | Whether to delete head branches when pull requests are merged Default: false |
deployments_url | string | Required within parent | Format: uri |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
disabled | boolean | Required within parent | Returns whether or not this repository disabled. |
downloads_url | string | Required within parent | Format: uri |
events_url | string | Required within parent | Format: uri |
fork | boolean | Required within parent | |
forks | JSON | Required within parent | |
forks (anyOf 1) | integer | Alternative | |
forks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forks_count | JSON | Required within parent | |
forks_count (anyOf 1) | integer | Alternative | |
forks_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forks_url | string | Required within parent | Format: uri |
full_name | string | Required within parent | |
git_commits_url | string | Required within parent | |
git_refs_url | string | Required within parent | |
git_tags_url | string | Required within parent | |
git_url | string | Required within parent | |
has_discussions | boolean | Optional | Whether discussions are enabled. Default: false |
has_issues | boolean | Required within parent | Whether issues are enabled. Default: true |
has_pages | boolean | Required within parent | |
has_projects | boolean | Required within parent | Whether projects are enabled. Default: true |
has_pull_requests | boolean | Optional | Whether pull requests are enabled. Default: true |
has_wiki | boolean | Required within parent | Whether the wiki is enabled. Default: true |
homepage | JSON | Required within parent | |
homepage (anyOf 1) | string | Alternative | Format: uri |
homepage (anyOf 2) | null | Alternative | |
hooks_url | string | Required within parent | Format: uri |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the repository Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
is_template | boolean | Optional | Whether this repository acts as a template that can be used to generate new repositories. Default: false |
issue_comment_url | string | Required within parent | |
issue_events_url | string | Required within parent | |
issues_url | string | Required within parent | |
keys_url | string | Required within parent | |
labels_url | string | Required within parent | |
language | JSON | Required within parent | |
language (anyOf 1) | string | Alternative | |
language (anyOf 2) | null | Alternative | |
languages_url | string | Required within parent | Format: uri |
license | Model | Required within parent | Expand Create a fork — response body — license |
merge_commit_message | string | Optional | 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. Known values: PR_BODY, PR_TITLE, BLANK |
merge_commit_title | string | Optional | 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). Known values: PR_TITLE, MERGE_MESSAGE |
merges_url | string | Required within parent | Format: uri |
milestones_url | string | Required within parent | |
mirror_url | JSON | Required within parent | |
mirror_url (anyOf 1) | string | Alternative | Format: uri |
mirror_url (anyOf 2) | null | Alternative | |
name | string | Required within parent | The name of the repository. |
node_id | string | Required within parent | |
notifications_url | string | Required within parent | |
open_issues | JSON | Required within parent | |
open_issues (anyOf 1) | integer | Alternative | |
open_issues (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
open_issues_count | JSON | Required within parent | |
open_issues_count (anyOf 1) | integer | Alternative | |
open_issues_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
owner | Model | Required within parent | Expand List users — response body — item |
permissions | object | Optional | |
permissions.admin | boolean | Required within parent | |
permissions.maintain | boolean | Optional | |
permissions.pull | boolean | Required within parent | |
permissions.push | boolean | Required within parent | |
permissions.triage | boolean | Optional | |
private | boolean | Required within parent | Whether the repository is private or public. Default: false |
pull_request_creation_policy | string | Optional | The policy controlling who can create pull requests: all or collaborators_only. Known values: all, collaborators_only |
pulls_url | string | Required within parent | |
pushed_at | JSON | Required within parent | |
pushed_at (anyOf 1) | string | Alternative | Format: date-time |
pushed_at (anyOf 2) | null | Alternative | |
releases_url | string | Required within parent | |
size | JSON | Required within parent | |
size (anyOf 1) | integer | Alternative | The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
squash_merge_commit_message | string | Optional | 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. Known values: PR_BODY, COMMIT_MESSAGES, BLANK |
squash_merge_commit_title | string | Optional | 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). Known values: PR_TITLE, COMMIT_OR_PR_TITLE |
ssh_url | string | Required within parent | |
stargazers_count | JSON | Required within parent | |
stargazers_count (anyOf 1) | integer | Alternative | |
stargazers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
stargazers_url | string | Required within parent | Format: uri |
starred_at | string | Optional | |
statuses_url | string | Required within parent | |
subscribers_url | string | Required within parent | Format: uri |
subscription_url | string | Required within parent | Format: uri |
svn_url | string | Required within parent | Format: uri |
tags_url | string | Required within parent | Format: uri |
teams_url | string | Required within parent | Format: uri |
temp_clone_token | string | Optional | When present and non-empty, a temporary credential for read-only Git access to this repository. It expires five minutes after generation and cannot be used to push changes. Treat this value as sensitive and avoid recording it in logs. |
topics | array | Optional | |
topics[] | string | Each item | |
trees_url | string | Required within parent | |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
url | string | Required within parent | Format: uri |
visibility | string | Optional | The repository visibility: public, private, or internal. Default: public |
watchers | JSON | Required within parent | |
watchers (anyOf 1) | integer | Alternative | |
watchers (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
watchers_count | JSON | Required within parent | |
watchers_count (anyOf 1) | integer | Alternative | |
watchers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
web_commit_signoff_required | boolean | Optional | Whether to require contributors to sign off on web-based commits Default: false |
Referenced models: Create a fork — response body — license, List users — response body — item
Create a repository ruleset — request body — body bypass actors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An actor that can bypass rules in a ruleset |
actor_id | JSON | Optional | |
actor_id (anyOf 1) | integer | Alternative | The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. |
actor_id (anyOf 2) | null | Alternative | |
actor_type | string | Required within parent | The type of actor that can bypass a ruleset. One of: Integration, OrganizationAdmin, RepositoryRole, Team, DeployKey, User |
bypass_mode | string | Optional | When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. Default: always One of: always, pull_request, exempt |
Create a repository ruleset — request body — body conditions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parameters for a repository ruleset ref name condition |
ref_name | object | Optional | |
ref_name.exclude | array | Optional | Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. |
ref_name.exclude[] | string | Each item | |
ref_name.include | array | Optional | 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. |
ref_name.include[] | string | Each item |
Create a repository ruleset — request body — body rules item
Referenced models: Create a repository ruleset — request body — body rules item branch name pattern, Create a repository ruleset — request body — body rules item code coverage, Create a repository ruleset — request body — body rules item code quality, Create a repository ruleset — request body — body rules item code scanning, Create a repository ruleset — request body — body rules item commit author email pattern, Create a repository ruleset — request body — body rules item commit message pattern, Create a repository ruleset — request body — body rules item committer email pattern, Create a repository ruleset — request body — body rules item copilot code review, Create a repository ruleset — request body — body rules item creation, Create a repository ruleset — request body — body rules item deletion, Create a repository ruleset — request body — body rules item file extension restriction, Create a repository ruleset — request body — body rules item file path restriction, Create a repository ruleset — request body — body rules item license compliance scanning, Create a repository ruleset — request body — body rules item max file path length, Create a repository ruleset — request body — body rules item max file size, Create a repository ruleset — request body — body rules item merge queue, Create a repository ruleset — request body — body rules item non fast forward, Create a repository ruleset — request body — body rules item pull request, Create a repository ruleset — request body — body rules item required deployments, Create a repository ruleset — request body — body rules item required linear history, Create a repository ruleset — request body — body rules item required signatures, Create a repository ruleset — request body — body rules item required status checks, Create a repository ruleset — request body — body rules item tag name pattern, Create a repository ruleset — request body — body rules item update, Create a repository ruleset — request body — body rules item workflows
Create a repository ruleset — request body — body rules item branch name pattern
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parameters to be used for the branch_name_pattern rule |
parameters | object | Optional | |
parameters.name | string | Optional | How this rule appears when configuring it. |
parameters.negate | boolean | Optional | If true, the rule will fail if the pattern matches. |
parameters.operator | string | Required within parent | The operator to use for matching. One of: starts_with, ends_with, contains, regex |
parameters.pattern | string | Required within parent | The pattern to match with. |
type | string | Required within parent | One of: branch_name_pattern |
Create a repository ruleset — request body — body rules item code coverage
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Enforce minimum line coverage thresholds on pull requests. This rule evaluates uploaded coverage data but does not wait for coverage uploads. To ensure coverage is evaluated before merging, make each status check associated with a coverage upload a required status check. |
parameters | object | Optional | |
parameters.max_coverage_drop | number | Optional | The maximum percentage points that line coverage may drop relative to the default branch. Pull requests that reduce line coverage by more than this amount will be blocked. Format: float Maximum: 100.0 Minimum: 0.0 |
parameters.minimum_coverage | number | Optional | The absolute minimum line coverage percentage required. Pull requests with line coverage below this threshold will be blocked. Format: float Maximum: 100.0 Minimum: 0.0 |
type | string | Required within parent | One of: code_coverage |
Create a repository ruleset — request body — body rules item code quality
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Choose which severity levels of code quality results should block pull request merges. When configured, a code quality analysis must be done on the pull request before the changes can be merged. |
parameters | object | Optional | |
parameters.severity | string | Required within parent | The lowest severity level at which code quality reviews need to be resolved before commits can be merged. One of: errors, warnings, notes, all |
type | string | Required within parent | One of: code_quality |
Create a repository ruleset — request body — body rules item code scanning
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. |
parameters | object | Optional | |
parameters.code_scanning_tools | array | Required within parent | Tools that must provide code scanning results for this rule to pass. |
parameters.code_scanning_tools[] | Model | Each item | Expand Create a repository ruleset — request body — body rules item code scanning parameters code scanning tools item |
type | string | Required within parent | One of: code_scanning |
Referenced models: Create a repository ruleset — request body — body rules item code scanning parameters code scanning tools item
Create a repository ruleset — request body — body rules item code scanning parameters code scanning tools item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A tool that must provide code scanning results for this rule to pass. |
alerts_threshold | string | Required within parent | The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." One of: none, errors, errors_and_warnings, all |
security_alerts_threshold | string | Required within parent | The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." One of: none, critical, high_or_higher, medium_or_higher, all |
tool | string | Required within parent | The name of a code scanning tool |
Create a repository ruleset — request body — body rules item commit author email pattern
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parameters to be used for the commit_author_email_pattern rule |
parameters | object | Optional | |
parameters.name | string | Optional | How this rule appears when configuring it. |
parameters.negate | boolean | Optional | If true, the rule will fail if the pattern matches. |
parameters.operator | string | Required within parent | The operator to use for matching. One of: starts_with, ends_with, contains, regex |
parameters.pattern | string | Required within parent | The pattern to match with. |
type | string | Required within parent | One of: commit_author_email_pattern |
Create a repository ruleset — request body — body rules item commit message pattern
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parameters to be used for the commit_message_pattern rule |
parameters | object | Optional | |
parameters.name | string | Optional | How this rule appears when configuring it. |
parameters.negate | boolean | Optional | If true, the rule will fail if the pattern matches. |
parameters.operator | string | Required within parent | The operator to use for matching. One of: starts_with, ends_with, contains, regex |
parameters.pattern | string | Required within parent | The pattern to match with. |
type | string | Required within parent | One of: commit_message_pattern |
Create a repository ruleset — request body — body rules item committer email pattern
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parameters to be used for the committer_email_pattern rule |
parameters | object | Optional | |
parameters.name | string | Optional | How this rule appears when configuring it. |
parameters.negate | boolean | Optional | If true, the rule will fail if the pattern matches. |
parameters.operator | string | Required within parent | The operator to use for matching. One of: starts_with, ends_with, contains, regex |
parameters.pattern | string | Required within parent | The pattern to match with. |
type | string | Required within parent | One of: committer_email_pattern |
Create a repository ruleset — request body — body rules item copilot code review
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and AI credits. |
parameters | object | Optional | |
parameters.review_draft_pull_requests | boolean | Optional | Copilot automatically reviews draft pull requests before they are marked as ready for review. |
parameters.review_on_push | boolean | Optional | Copilot automatically reviews each new push to the pull request. |
type | string | Required within parent | One of: copilot_code_review |
Create a repository ruleset — request body — body rules item creation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Only allow users with bypass permission to create matching refs. |
type | string | Required within parent | One of: creation |
Create a repository ruleset — request body — body rules item deletion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Only allow users with bypass permissions to delete matching refs. |
type | string | Required within parent | One of: deletion |
Create a repository ruleset — request body — body rules item file extension restriction
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Prevent commits that include files with specified file extensions from being pushed to the commit graph. |
parameters | object | Optional | |
parameters.restricted_file_extensions | array | Required within parent | The file extensions that are restricted from being pushed to the commit graph. |
parameters.restricted_file_extensions[] | string | Each item | |
type | string | Required within parent | One of: file_extension_restriction |
Create a repository ruleset — request body — body rules item file path restriction
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names. |
parameters | object | Optional | |
parameters.ignored_file_paths | array | Optional | Files matching these patterns are allowed even when they also match a restricted path. |
parameters.ignored_file_paths[] | string | Each item | |
parameters.restricted_file_paths | array | Required within parent | The file paths that are restricted from being pushed to the commit graph. |
parameters.restricted_file_paths[] | string | Each item | |
type | string | Required within parent | One of: file_path_restriction |
Create a repository ruleset — request body — body rules item license compliance scanning
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Enforce any added or changed dependencies to comply with the organization's license policy. |
type | string | Required within parent | One of: license_compliance_scanning |
Create a repository ruleset — request body — body rules item max file path length
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph. |
parameters | object | Optional | |
parameters.max_file_path_length | integer | Required within parent | The maximum amount of characters allowed in file paths. Maximum: 32767 Minimum: 1 |
type | string | Required within parent | One of: max_file_path_length |
Create a repository ruleset — request body — body rules item max file size
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. |
parameters | object | Optional | |
parameters.ignored_file_paths | array | Optional | Files matching these patterns may exceed the maximum size. |
parameters.ignored_file_paths[] | string | Each item | |
parameters.max_file_size | integer | Required within parent | The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). Maximum: 100 Minimum: 1 |
type | string | Required within parent | One of: max_file_size |
Create a repository ruleset — request body — body rules item merge queue
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Merges must be performed via a merge queue. |
parameters | object | Optional | |
parameters.check_response_timeout_minutes | integer | Required within parent | Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed Maximum: 360 Minimum: 1 |
parameters.grouping_strategy | string | Required within parent | When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. One of: ALLGREEN, HEADGREEN |
parameters.max_entries_to_build | integer | Required within parent | Limit the number of queued pull requests requesting checks and workflow runs at the same time. Maximum: 100 Minimum: 0 |
parameters.max_entries_to_merge | integer | Required within parent | The maximum number of PRs that will be merged together in a group. Maximum: 100 Minimum: 0 |
parameters.merge_method | string | Required within parent | Method to use when merging changes from queued pull requests. One of: MERGE, SQUASH, REBASE |
parameters.min_entries_to_merge | integer | Required within parent | The minimum number of PRs that will be merged together in a group. Maximum: 100 Minimum: 0 |
parameters.min_entries_to_merge_wait_minutes | integer | Required within parent | The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. Maximum: 360 Minimum: 0 |
type | string | Required within parent | One of: merge_queue |
Create a repository ruleset — request body — body rules item non fast forward
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Prevent users with push access from force pushing to refs. |
type | string | Required within parent | One of: non_fast_forward |
Create a repository ruleset — request body — body rules item pull request
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. |
parameters | object | Optional | |
parameters.allowed_merge_methods | array | Optional | Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. |
parameters.allowed_merge_methods[] | string | Each item | One of: merge, squash, rebase |
parameters.dismiss_stale_reviews_on_push | boolean | Required within parent | New, reviewable commits pushed will dismiss previous pull request review approvals. |
parameters.dismissal_restriction | Model | Optional | Expand Create a repository ruleset — request body — body rules item pull request parameters dismissal restriction |
parameters.require_code_owner_review | boolean | Required within parent | Require an approving review in pull requests that modify files that have a designated code owner. |
parameters.require_extra_approval_for_unattributed_changes | boolean | Optional | When Copilot opens a pull request without a human collaborator, require one more approving review if a non-zero approval count is required. |
parameters.require_last_push_approval | boolean | Required within parent | Whether the most recent reviewable push must be approved by someone other than the person who pushed it. |
parameters.required_approving_review_count | integer | Required within parent | The number of approving reviews that are required before a pull request can be merged. Maximum: 10 Minimum: 0 |
parameters.required_review_thread_resolution | boolean | Required within parent | All conversations on code must be resolved before a pull request can be merged. |
parameters.required_reviewers | array | Optional | A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. |
parameters.required_reviewers[] | Model | Each item | Expand Create a repository ruleset — request body — body rules item pull request parameters required reviewers item |
type | string | Required within parent | One of: pull_request |
Referenced models: Create a repository ruleset — request body — body rules item pull request parameters dismissal restriction, Create a repository ruleset — request body — body rules item pull request parameters required reviewers item
Create a repository ruleset — request body — body rules item pull request parameters dismissal restriction
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specify people, teams, or apps allowed to dismiss pull request reviews. |
allowed_actors | array | Optional | Specify people, teams, or apps allowed to dismiss pull request reviews. |
allowed_actors[] | Model | Each item | Expand Create a repository ruleset — request body — body rules item pull request parameters dismissal restriction allowed actors item |
enabled | boolean | Required within parent | Whether to restrict review dismissal to specific actors. |
Referenced models: Create a repository ruleset — request body — body rules item pull request parameters dismissal restriction allowed actors item
Create a repository ruleset — request body — body rules item pull request parameters dismissal restriction allowed actors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An actor allowed to dismiss pull request reviews |
id | integer | Required within parent | ID of the actor that can dismiss reviews. |
type | string | Required within parent | The type of the actor One of: User, Team, IntegrationInstallation, RepositoryRole |
Create a repository ruleset — request body — body rules item pull request parameters required reviewers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A reviewing team, and file patterns describing which files they must approve changes to. |
file_patterns | array | Required within parent | Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax. |
file_patterns[] | string | Each item | |
minimum_approvals | integer | Required within parent | Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. |
reviewer | Model | Required within parent | Expand Create a repository ruleset — request body — body rules item pull request parameters required reviewers item reviewer |
Referenced models: Create a repository ruleset — request body — body rules item pull request parameters required reviewers item reviewer
Create a repository ruleset — request body — body rules item pull request parameters required reviewers item reviewer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A required reviewing team |
id | integer | Required within parent | ID of the reviewer which must review changes to matching files. |
type | string | Required within parent | The type of the reviewer One of: Team |
Create a repository ruleset — request body — body rules item required deployments
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. |
parameters | object | Optional | |
parameters.required_deployment_environments | array | Required within parent | The environments that must be successfully deployed to before branches can be merged. |
parameters.required_deployment_environments[] | string | Each item | |
type | string | Required within parent | One of: required_deployments |
Create a repository ruleset — request body — body rules item required linear history
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Prevent merge commits from being pushed to matching refs. |
type | string | Required within parent | One of: required_linear_history |
Create a repository ruleset — request body — body rules item required signatures
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Commits pushed to matching refs must have verified signatures. |
type | string | Required within parent | One of: required_signatures |
Create a repository ruleset — request body — body rules item required status checks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. |
parameters | object | Optional | |
parameters.do_not_enforce_on_create | boolean | Optional | Allow repositories and branches to be created if a check would otherwise prohibit it. |
parameters.required_status_checks | array | Required within parent | Status checks that are required. |
parameters.required_status_checks[] | Model | Each item | Expand Create a repository ruleset — request body — body rules item required status checks parameters required status checks item |
parameters.strict_required_status_checks_policy | boolean | Required within parent | 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. |
type | string | Required within parent | One of: required_status_checks |
Referenced models: Create a repository ruleset — request body — body rules item required status checks parameters required status checks item
Create a repository ruleset — request body — body rules item required status checks parameters required status checks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Required status check |
context | string | Required within parent | The status check context name that must be present on the commit. |
integration_id | integer | Optional | The optional integration ID that this status check must originate from. |
Create a repository ruleset — request body — body rules item tag name pattern
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parameters to be used for the tag_name_pattern rule |
parameters | object | Optional | |
parameters.name | string | Optional | How this rule appears when configuring it. |
parameters.negate | boolean | Optional | If true, the rule will fail if the pattern matches. |
parameters.operator | string | Required within parent | The operator to use for matching. One of: starts_with, ends_with, contains, regex |
parameters.pattern | string | Required within parent | The pattern to match with. |
type | string | Required within parent | One of: tag_name_pattern |
Create a repository ruleset — request body — body rules item update
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Only allow users with bypass permission to update matching refs. |
parameters | object | Optional | |
parameters.update_allows_fetch_and_merge | boolean | Required within parent | Branch can pull changes from its upstream repository |
type | string | Required within parent | One of: update |
Create a repository ruleset — request body — body rules item workflows
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Require all changes made to a targeted branch to pass the specified workflows before they can be merged. |
parameters | object | Optional | |
parameters.do_not_enforce_on_create | boolean | Optional | Allow repositories and branches to be created if a check would otherwise prohibit it. |
parameters.workflows | array | Required within parent | Workflows that must pass for this rule to pass. |
parameters.workflows[] | Model | Each item | Expand Create a repository ruleset — request body — body rules item workflows parameters workflows item |
type | string | Required within parent | One of: workflows |
Referenced models: Create a repository ruleset — request body — body rules item workflows parameters workflows item
Create a repository ruleset — request body — body rules item workflows parameters workflows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A workflow that must run for this rule to pass |
path | string | Required within parent | The path to the workflow file |
ref | string | Optional | The ref (branch or tag) of the workflow file to use |
repository_id | integer | Required within parent | The ID of the repository where the workflow is defined |
sha | string | Optional | The commit SHA of the workflow file to use |
Create an organization repository ruleset — request body — body conditions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. The push rulesets conditions object does not require the `ref_name` property. For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. |
$ (oneOf 1) | object | Alternative | Conditions to target repositories by name and refs by name |
$ (oneOf 1) (allOf 1) | Model | All variants apply | Expand Create a repository ruleset — request body — body conditions |
$ (oneOf 1) (allOf 2) | Model | All variants apply | Expand Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names |
$ (oneOf 2) | object | Alternative | Conditions to target repositories by id and refs by name |
$ (oneOf 2) (allOf 1) | Model | All variants apply | Expand Create a repository ruleset — request body — body conditions |
$ (oneOf 2) (allOf 2) | Model | All variants apply | Expand Create an organization Actions policy — request body — body conditions repository id, workflow path Repository ruleset conditions for repository I Ds |
$ (oneOf 3) | object | Alternative | Conditions to target repositories by property and refs by name |
$ (oneOf 3) (allOf 1) | Model | All variants apply | Expand Create a repository ruleset — request body — body conditions |
$ (oneOf 3) (allOf 2) | Model | All variants apply | Expand Create an organization Actions policy — request body — body conditions repository property, workflow path Repository ruleset conditions for repository properties |
Referenced models: Create a repository ruleset — request body — body conditions, Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names, Create an organization Actions policy — request body — body conditions repository id, workflow path Repository ruleset conditions for repository I Ds, Create an organization Actions policy — request body — body conditions repository property, workflow path Repository ruleset conditions for repository properties
Create an organization repository ruleset — request body — body rules item
Referenced models: Create a repository ruleset — request body — body rules item branch name pattern, Create a repository ruleset — request body — body rules item code scanning, Create a repository ruleset — request body — body rules item commit author email pattern, Create a repository ruleset — request body — body rules item commit message pattern, Create a repository ruleset — request body — body rules item committer email pattern, Create a repository ruleset — request body — body rules item copilot code review, Create a repository ruleset — request body — body rules item creation, Create a repository ruleset — request body — body rules item deletion, Create a repository ruleset — request body — body rules item file extension restriction, Create a repository ruleset — request body — body rules item file path restriction, Create a repository ruleset — request body — body rules item max file path length, Create a repository ruleset — request body — body rules item max file size, Create a repository ruleset — request body — body rules item non fast forward, Create a repository ruleset — request body — body rules item pull request, Create a repository ruleset — request body — body rules item required deployments, Create a repository ruleset — request body — body rules item required linear history, Create a repository ruleset — request body — body rules item required signatures, Create a repository ruleset — request body — body rules item required status checks, Create a repository ruleset — request body — body rules item tag name pattern, Create a repository ruleset — request body — body rules item update, Create a repository ruleset — request body — body rules item workflows
Create or update custom property values for a repository — request body — body properties item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Custom property name and associated value |
property_name | string | Required within parent | The name of the property |
value | JSON | Required within parent | |
value (anyOf 1) | JSON | Alternative | The value assigned to the property |
value (anyOf 1) (oneOf 1) | JSON | Alternative | |
value (anyOf 1) (oneOf 1) (anyOf 1) | string | Alternative | |
value (anyOf 1) (oneOf 1) (anyOf 2) | null | Alternative | |
value (anyOf 1) (oneOf 2) | array | Alternative | |
value (anyOf 1) (oneOf 2)[] | string | Each item | |
value (anyOf 2) | null | Alternative |
Delete a file — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | File Commit |
commit | Model | Required within parent | Expand Delete a file — response body — commit |
content | JSON | Required within parent | |
content (anyOf 1) | object | Alternative | |
content (anyOf 1)._links | object | Optional | |
content (anyOf 1)._links.git | string | Optional | |
content (anyOf 1)._links.html | string | Optional | |
content (anyOf 1)._links.self | string | Optional | |
content (anyOf 1).download_url | string | Optional | |
content (anyOf 1).git_url | string | Optional | |
content (anyOf 1).html_url | string | Optional | |
content (anyOf 1).name | string | Optional | |
content (anyOf 1).path | string | Optional | |
content (anyOf 1).sha | string | Optional | |
content (anyOf 1).size | JSON | Optional | |
content (anyOf 1).size (anyOf 1) | integer | Alternative | |
content (anyOf 1).size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
content (anyOf 1).type | string | Optional | |
content (anyOf 1).url | string | Optional | |
content (anyOf 2) | null | Alternative |
Referenced models: Delete a file — response body — commit
Delete a file — response body — commit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
author | object | Optional | |
author.date | string | Optional | |
author.email | string | Optional | |
author.name | string | Optional | |
committer | object | Optional | |
committer.date | string | Optional | |
committer.email | string | Optional | |
committer.name | string | Optional | |
html_url | string | Optional | |
message | string | Optional | |
node_id | string | Optional | |
parents | array | Optional | |
parents[] | object | Each item | |
parents[].html_url | string | Optional | |
parents[].sha | string | Optional | |
parents[].url | string | Optional | |
sha | string | Optional | |
tree | object | Optional | |
tree.sha | string | Optional | |
tree.url | string | Optional | |
url | string | Optional | |
verification | object | Optional | |
verification.payload | JSON | Optional | |
verification.payload (anyOf 1) | string | Alternative | |
verification.payload (anyOf 2) | null | Alternative | |
verification.reason | string | Optional | |
verification.signature | JSON | Optional | |
verification.signature (anyOf 1) | string | Alternative | |
verification.signature (anyOf 2) | null | Alternative | |
verification.verified | boolean | Optional | |
verification.verified_at | JSON | Optional | |
verification.verified_at (anyOf 1) | string | Alternative | |
verification.verified_at (anyOf 2) | null | Alternative |
Generate release notes content for a release — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Generated name and body describing a release |
body | string | Required within parent | The generated body describing the contents of the release supporting markdown formatting |
name | string | Required within parent | The generated name of the release |
Get Git Hub Pages build — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Page Build |
commit | string | Required within parent | |
created_at | string | Required within parent | Format: date-time |
duration | JSON | Required within parent | |
duration (anyOf 1) | integer | Alternative | |
duration (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
error | object | Required within parent | |
error.message | JSON | Required within parent | |
error.message (anyOf 1) | string | Alternative | |
error.message (anyOf 2) | null | Alternative | |
pusher | Model | Required within parent | Expand Get an issue — response body — user |
status | string | Required within parent | |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
Referenced models: Get an issue — response body — user
Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pages Health Check Status |
alt_domain | JSON | Optional | |
alt_domain (anyOf 1) | Model | Alternative | Expand Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status domain |
alt_domain (anyOf 2) | null | Alternative | |
domain | Model | Optional | Expand Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status domain |
Referenced models: Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status domain
Get a DNS health check for Git Hub Pages — response body — Pages Health Check Status domain
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
caa_error | JSON | Optional | |
caa_error (anyOf 1) | string | Alternative | |
caa_error (anyOf 2) | null | Alternative | |
dns_resolves | boolean | Optional | |
enforces_https | boolean | Optional | |
has_cname_record | JSON | Optional | |
has_cname_record (anyOf 1) | boolean | Alternative | |
has_cname_record (anyOf 2) | null | Alternative | |
has_mx_records_present | JSON | Optional | |
has_mx_records_present (anyOf 1) | boolean | Alternative | |
has_mx_records_present (anyOf 2) | null | Alternative | |
host | string | Optional | |
https_error | JSON | Optional | |
https_error (anyOf 1) | string | Alternative | |
https_error (anyOf 2) | null | Alternative | |
is_a_record | JSON | Optional | |
is_a_record (anyOf 1) | boolean | Alternative | |
is_a_record (anyOf 2) | null | Alternative | |
is_apex_domain | boolean | Optional | |
is_cloudflare_ip | JSON | Optional | |
is_cloudflare_ip (anyOf 1) | boolean | Alternative | |
is_cloudflare_ip (anyOf 2) | null | Alternative | |
is_cname_to_fastly | JSON | Optional | |
is_cname_to_fastly (anyOf 1) | boolean | Alternative | |
is_cname_to_fastly (anyOf 2) | null | Alternative | |
is_cname_to_github_user_domain | JSON | Optional | |
is_cname_to_github_user_domain (anyOf 1) | boolean | Alternative | |
is_cname_to_github_user_domain (anyOf 2) | null | Alternative | |
is_cname_to_pages_dot_github_dot_com | JSON | Optional | |
is_cname_to_pages_dot_github_dot_com (anyOf 1) | boolean | Alternative | |
is_cname_to_pages_dot_github_dot_com (anyOf 2) | null | Alternative | |
is_fastly_ip | JSON | Optional | |
is_fastly_ip (anyOf 1) | boolean | Alternative | |
is_fastly_ip (anyOf 2) | null | Alternative | |
is_https_eligible | JSON | Optional | |
is_https_eligible (anyOf 1) | boolean | Alternative | |
is_https_eligible (anyOf 2) | null | Alternative | |
is_non_github_pages_ip_present | JSON | Optional | |
is_non_github_pages_ip_present (anyOf 1) | boolean | Alternative | |
is_non_github_pages_ip_present (anyOf 2) | null | Alternative | |
is_old_ip_address | JSON | Optional | |
is_old_ip_address (anyOf 1) | boolean | Alternative | |
is_old_ip_address (anyOf 2) | null | Alternative | |
is_pages_domain | boolean | Optional | |
is_pointed_to_github_pages_ip | JSON | Optional | |
is_pointed_to_github_pages_ip (anyOf 1) | boolean | Alternative | |
is_pointed_to_github_pages_ip (anyOf 2) | null | Alternative | |
is_proxied | JSON | Optional | |
is_proxied (anyOf 1) | boolean | Alternative | |
is_proxied (anyOf 2) | null | Alternative | |
is_served_by_pages | JSON | Optional | |
is_served_by_pages (anyOf 1) | boolean | Alternative | |
is_served_by_pages (anyOf 2) | null | Alternative | |
is_valid | boolean | Optional | |
is_valid_domain | boolean | Optional | |
nameservers | string | Optional | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | |
reason (anyOf 2) | null | Alternative | |
responds_to_https | boolean | Optional | |
should_be_a_record | JSON | Optional | |
should_be_a_record (anyOf 1) | boolean | Alternative | |
should_be_a_record (anyOf 2) | null | Alternative | |
uri | string | Optional |
Get a Git Hub Pages site — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The configuration for GitHub Pages for a repository. |
build_type | JSON | Optional | |
build_type (anyOf 1) | string | Alternative | The process in which the Page will be built. Known values: legacy, workflow |
build_type (anyOf 2) | null | Alternative | |
cname | JSON | Required within parent | |
cname (anyOf 1) | string | Alternative | The Pages site's custom domain |
cname (anyOf 2) | null | Alternative | |
custom_404 | boolean | Required within parent | Whether the Page has a custom 404 page. Default: false |
html_url | string | Optional | The web address the Page can be accessed from. Format: uri |
https_certificate | Model | Optional | Expand Get a Git Hub Pages site — response body — https certificate |
https_enforced | boolean | Optional | Whether https is enabled on the domain |
pending_domain_unverified_at | JSON | Optional | |
pending_domain_unverified_at (anyOf 1) | string | Alternative | The timestamp when a pending domain becomes unverified. Format: date-time |
pending_domain_unverified_at (anyOf 2) | null | Alternative | |
protected_domain_state | JSON | Optional | |
protected_domain_state (anyOf 1) | string | Alternative | The state if the domain is verified Known values: pending, verified, unverified |
protected_domain_state (anyOf 2) | null | Alternative | |
public | boolean | Required within parent | Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. |
source | Model | Optional | Expand Get a Git Hub Pages site — response body — source |
status | JSON | Required within parent | |
status (anyOf 1) | string | Alternative | The status of the most recent build of the Page. Known values: built, building, errored |
status (anyOf 2) | null | Alternative | |
url | string | Required within parent | The API address for accessing this Page resource. Format: uri |
Referenced models: Get a Git Hub Pages site — response body — https certificate, Get a Git Hub Pages site — response body — source
Get a Git Hub Pages site — response body — https certificate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | |
domains | array | Required within parent | Array of the domain set and its alternate name (if it is configured) |
domains[] | string | Each item | |
expires_at | string | Optional | Format: date |
state | string | Required within parent | Known values: new, authorization_created, authorization_pending, authorized, authorization_revoked, issued, uploaded, approved, errored, bad_authz, destroy_pending, dns_changed |
Get a Git Hub Pages site — response body — source
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
branch | string | Required within parent | |
path | string | Required within parent |
Get a branch — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Branch With Protection |
_links | object | Required within parent | |
_links.html | string | Required within parent | |
_links.self | string | Required within parent | Format: uri |
commit | Model | Required within parent | Expand Get a commit — response body |
name | string | Required within parent | |
pattern | string | Optional | |
protected | boolean | Required within parent | |
protection | Model | Required within parent | Expand Get branch protection — response body |
protection_url | string | Required within parent | Format: uri |
required_approving_review_count | JSON | Optional | |
required_approving_review_count (anyOf 1) | integer | Alternative | |
required_approving_review_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get branch protection — response body, Get a commit — response body
Get a commit comment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Commit Comment |
author_association | string | Required within parent | How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER |
body | string | Required within parent | |
commit_id | string | Required within parent | |
created_at | string | Required within parent | Format: date-time |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
line | JSON | Required within parent | |
line (anyOf 1) | JSON | Alternative | |
line (anyOf 1) (anyOf 1) | integer | Alternative | |
line (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
line (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | |
path | JSON | Required within parent | |
path (anyOf 1) | string | Alternative | |
path (anyOf 2) | null | Alternative | |
position | JSON | Required within parent | |
position (anyOf 1) | JSON | Alternative | |
position (anyOf 1) (anyOf 1) | integer | Alternative | |
position (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
position (anyOf 2) | null | Alternative | |
reactions | Model | Optional | Expand Get an issue — response body — reactions |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
user | Model | Required within parent | Expand Get an issue — response body — user |
Referenced models: Get an issue — response body — user, Get an issue — response body — reactions
Get a commit — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Commit |
author | JSON | Required within parent | |
author (anyOf 1) | JSON | Alternative | |
author (anyOf 1) (anyOf 1) | Model | Alternative | Expand List users — response body — item |
author (anyOf 1) (anyOf 2) | Model | Alternative | Expand Re-run a workflow — response body |
author (anyOf 2) | null | Alternative | |
comments_url | string | Required within parent | Format: uri |
commit | object | Required within parent | |
commit.author | Model | Required within parent | Expand Get a commit — response body — commit author |
commit.comment_count | JSON | Required within parent | |
commit.comment_count (anyOf 1) | integer | Alternative | |
commit.comment_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
commit.committer | Model | Required within parent | Expand Get a commit — response body — commit author |
commit.message | string | Required within parent | |
commit.tree | object | Required within parent | |
commit.tree.sha | string | Required within parent | |
commit.tree.url | string | Required within parent | Format: uri |
commit.url | string | Required within parent | Format: uri |
commit.verification | Model | Optional | Expand Get a tag — response body — verification |
committer | JSON | Required within parent | |
committer (anyOf 1) | JSON | Alternative | |
committer (anyOf 1) (anyOf 1) | Model | Alternative | Expand List users — response body — item |
committer (anyOf 1) (anyOf 2) | Model | Alternative | Expand Re-run a workflow — response body |
committer (anyOf 2) | null | Alternative | |
files | array | Optional | |
files[] | Model | Each item | Expand List pull requests files — response body — item |
html_url | string | Required within parent | Format: uri |
node_id | string | Required within parent | |
parents | array | Required within parent | |
parents[] | object | Each item | |
parents[].html_url | string | Optional | Format: uri |
parents[].sha | string | Required within parent | |
parents[].url | string | Required within parent | Format: uri |
sha | string | Required within parent | |
stats | object | Optional | |
stats.additions | JSON | Optional | |
stats.additions (anyOf 1) | integer | Alternative | |
stats.additions (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
stats.deletions | JSON | Optional | |
stats.deletions (anyOf 1) | integer | Alternative | |
stats.deletions (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
stats.total | JSON | Optional | |
stats.total (anyOf 1) | integer | Alternative | |
stats.total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
url | string | Required within parent | Format: uri |
Referenced models: List pull requests files — response body — item, Re-run a workflow — response body, Get a commit — response body — commit author, List users — response body — item, Get a tag — response body — verification
Get a commit — response body — commit author
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Metaproperties for Git author/committer information. |
$ (anyOf 1).date | string | Optional | Format: date-time |
$ (anyOf 1).email | string | Optional | |
$ (anyOf 1).name | string | Optional | |
$ (anyOf 2) | null | Alternative |
Get a custom deployment protection rule — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Deployment protection rule |
app | Model | Required within parent | Expand Get a custom deployment protection rule — response body — app |
enabled | boolean | Required within parent | Whether the deployment protection rule is enabled for the environment. |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | The unique identifier for the deployment protection rule. |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | The node ID for the deployment protection rule. |
Referenced models: Get a custom deployment protection rule — response body — app
Get a custom deployment protection rule — response body — app
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A GitHub App that is providing a custom deployment protection rule. |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | The unique identifier of the deployment protection rule integration. |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
integration_url | string | Required within parent | The URL for the endpoint to get details about the app. |
node_id | string | Required within parent | The node ID for the deployment protection rule integration. |
slug | string | Required within parent | The slugified name of the deployment protection rule integration. |
Get a delivery for a repository webhook — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Delivery made by a webhook. |
action | JSON | Required within parent | |
action (anyOf 1) | string | Alternative | The type of activity for the event that triggered the delivery. |
action (anyOf 2) | null | Alternative | |
delivered_at | string | Required within parent | Time when the delivery was delivered. Format: date-time |
duration | JSON | Required within parent | |
duration (anyOf 1) | number | Alternative | Time spent delivering. |
duration (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
event | string | Required within parent | The event that triggered the delivery. |
guid | string | Required within parent | Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the delivery. |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
installation_id | JSON | Required within parent | |
installation_id (anyOf 1) | JSON | Alternative | |
installation_id (anyOf 1) (anyOf 1) | integer | Alternative | The id of the GitHub App installation associated with this event. |
installation_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
installation_id (anyOf 2) | null | Alternative | |
redelivery | boolean | Required within parent | Whether the delivery is a redelivery. |
repository_id | JSON | Required within parent | |
repository_id (anyOf 1) | JSON | Alternative | |
repository_id (anyOf 1) (anyOf 1) | integer | Alternative | The id of the repository associated with this event. |
repository_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
repository_id (anyOf 2) | null | Alternative | |
request | object | Required within parent | |
request.headers | JSON | Required within parent | |
request.headers (anyOf 1) | object | Alternative | The request headers sent with the webhook delivery. Additional keys: allowed |
request.headers (anyOf 2) | null | Alternative | |
request.payload | JSON | Required within parent | |
request.payload (anyOf 1) | object | Alternative | The webhook payload. Additional keys: allowed |
request.payload (anyOf 2) | null | Alternative | |
response | object | Required within parent | |
response.headers | JSON | Required within parent | |
response.headers (anyOf 1) | object | Alternative | The response headers received when the delivery was made. Additional keys: allowed |
response.headers (anyOf 2) | null | Alternative | |
response.payload | JSON | Required within parent | |
response.payload (anyOf 1) | string | Alternative | The response payload received. Additional keys: allowed |
response.payload (anyOf 2) | null | Alternative | |
status | string | Required within parent | Description of the status of the attempted delivery |
status_code | JSON | Required within parent | |
status_code (anyOf 1) | integer | Alternative | Status code received when delivery was made. |
status_code (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
throttled_at | JSON | Optional | |
throttled_at (anyOf 1) | string | Alternative | Time when the webhook delivery was throttled. Format: date-time |
throttled_at (anyOf 2) | null | Alternative | |
url | string | Optional | The URL target of the delivery. |
Get a deploy key — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An SSH key granting access to a single repository. |
added_by | JSON | Optional | |
added_by (anyOf 1) | string | Alternative | |
added_by (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | |
enabled | boolean | Optional | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
key | string | Required within parent | |
last_used | JSON | Optional | |
last_used (anyOf 1) | string | Alternative | Format: date-time |
last_used (anyOf 2) | null | Alternative | |
read_only | boolean | Required within parent | |
title | string | Required within parent | |
url | string | Required within parent | |
verified | boolean | Required within parent |
Get a deployment branch policy — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a deployment branch or tag policy. |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | The unique identifier of the branch or tag policy. |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | The name pattern that branches or tags must match in order to deploy to the environment. |
node_id | string | Optional | |
type | string | Optional | Whether this rule targets a branch or tag. Known values: branch, tag |
Get a deployment status — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The status of a deployment. |
created_at | string | Required within parent | Format: date-time |
creator | Model | Required within parent | Expand Get an issue — response body — user |
deployment_url | string | Required within parent | Format: uri |
description | string | Required within parent | A short description of the status. Default: Maximum length: 140 |
environment | string | Optional | The environment of the deployment that the status is for. Default: |
environment_url | string | Optional | The URL for accessing your environment. Default: Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
log_url | string | Optional | The URL to associate with this status. Default: Format: uri |
node_id | string | Required within parent | |
performed_via_github_app | Model | Optional | Expand Get an app — response body |
repository_url | string | Required within parent | Format: uri |
state | string | Required within parent | The state of the status. Known values: error, failure, inactive, pending, success, queued, in_progress |
target_url | string | Required within parent | Closing down notice: the URL to associate with this status. Default: Format: uri |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
Referenced models: Get an app — response body, Get an issue — response body — user
Get a deployment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A request for a specific ref(branch,sha,tag) to be deployed |
created_at | string | Required within parent | Format: date-time |
creator | Model | Required within parent | Expand Get an issue — response body — user |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
environment | string | Required within parent | Name for the target deployment environment. |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the deployment Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
original_environment | string | Optional | |
payload | JSON | Required within parent | |
payload (anyOf 1) | object | Alternative | Additional keys: allowed |
payload (anyOf 2) | string | Alternative | |
performed_via_github_app | Model | Optional | Expand Get an app — response body |
production_environment | boolean | Optional | Specifies if the given environment is one that end-users directly interact with. Default: false. |
ref | string | Required within parent | The ref to deploy. This can be a branch, tag, or sha. |
repository_url | string | Required within parent | Format: uri |
sha | string | Required within parent | |
statuses_url | string | Required within parent | Format: uri |
task | string | Required within parent | Parameter to specify a task to execute |
transient_environment | boolean | Optional | Specifies if the given environment is will no longer exist at some point in the future. Default: false. |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
Referenced models: Get an app — response body, Get an issue — response body — user
Get a release asset — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Data related to a release. |
browser_download_url | string | Required within parent | Format: uri |
content_type | string | Required within parent | |
created_at | string | Required within parent | Format: date-time |
digest | JSON | Required within parent | |
digest (anyOf 1) | string | Alternative | |
digest (anyOf 2) | null | Alternative | |
download_count | JSON | Required within parent | |
download_count (anyOf 1) | integer | Alternative | |
download_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
label | JSON | Required within parent | |
label (anyOf 1) | string | Alternative | |
label (anyOf 2) | null | Alternative | |
name | string | Required within parent | The file name of the asset. |
node_id | string | Required within parent | |
size | JSON | Required within parent | |
size (anyOf 1) | integer | Alternative | |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
state | string | Required within parent | State of the release asset. Known values: uploaded, open |
updated_at | string | Required within parent | Format: date-time |
uploader | Model | Required within parent | Expand Get an issue — response body — user |
url | string | Required within parent | Format: uri |
Referenced models: Get an issue — response body — user
Get a release — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A release. |
assets | array | Required within parent | |
assets[] | Model | Each item | Expand Get a release asset — response body |
assets_url | string | Required within parent | Format: uri |
author | Model | Required within parent | Expand List users — response body — item |
body | JSON | Optional | |
body (anyOf 1) | string | Alternative | |
body (anyOf 2) | null | Alternative | |
body_html | string | Optional | |
body_text | string | Optional | |
created_at | string | Required within parent | Format: date-time |
discussion_url | string | Optional | The URL of the release discussion. Format: uri |
draft | boolean | Required within parent | true to create a draft (unpublished) release, false to create a published one. |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
immutable | boolean | Optional | Whether or not the release is immutable. |
mentions_count | JSON | Optional | |
mentions_count (anyOf 1) | integer | Alternative | |
mentions_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | |
prerelease | boolean | Required within parent | Whether to identify the release as a prerelease or a full release. |
published_at | JSON | Required within parent | |
published_at (anyOf 1) | string | Alternative | Format: date-time |
published_at (anyOf 2) | null | Alternative | |
reactions | Model | Optional | Expand Get an issue — response body — reactions |
tag_name | string | Required within parent | The name of the tag. |
tarball_url | JSON | Required within parent | |
tarball_url (anyOf 1) | string | Alternative | Format: uri |
tarball_url (anyOf 2) | null | Alternative | |
target_commitish | string | Required within parent | Specifies the commitish value that determines where the Git tag is created from. |
updated_at | JSON | Optional | |
updated_at (anyOf 1) | string | Alternative | Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
upload_url | string | Required within parent | |
url | string | Required within parent | Format: uri |
zipball_url | JSON | Required within parent | |
zipball_url (anyOf 1) | string | Alternative | Format: uri |
zipball_url (anyOf 2) | null | Alternative |
Referenced models: Get an issue — response body — reactions, Get a release asset — response body, List users — response body — item
Get a repository README — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Content File |
_links | object | Required within parent | |
_links.git | JSON | Required within parent | |
_links.git (anyOf 1) | string | Alternative | Format: uri |
_links.git (anyOf 2) | null | Alternative | |
_links.html | JSON | Required within parent | |
_links.html (anyOf 1) | string | Alternative | Format: uri |
_links.html (anyOf 2) | null | Alternative | |
_links.self | string | Required within parent | Format: uri |
content | string | Required within parent | |
download_url | JSON | Required within parent | |
download_url (anyOf 1) | string | Alternative | Format: uri |
download_url (anyOf 2) | null | Alternative | |
encoding | string | Required within parent | |
git_url | JSON | Required within parent | |
git_url (anyOf 1) | string | Alternative | Format: uri |
git_url (anyOf 2) | null | Alternative | |
html_url | JSON | Required within parent | |
html_url (anyOf 1) | string | Alternative | Format: uri |
html_url (anyOf 2) | null | Alternative | |
name | string | Required within parent | |
path | string | Required within parent | |
sha | string | Required within parent | |
size | JSON | Required within parent | |
size (anyOf 1) | integer | Alternative | |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
submodule_git_url | string | Optional | |
target | string | Optional | |
type | string | Required within parent | Known values: file |
url | string | Required within parent | Format: uri |