GitHub v3 REST API

Commit

object

Commit

urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e

shastringrequired

Example:6dcb09b5b57875f334f61aebed695e2e4193db5e

node_idstringrequired

Example:MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==

html_urlstring(uri)required

Example:https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e

comments_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments

commitobjectrequired
Show Child Parameters
authorobjectrequired

Simple User

Show Child Parameters
committerobjectrequired

Simple User

Show Child Parameters
parentsarray[object]required
Show Child Parameters
statsobject
Show Child Parameters
filesarray[object]

Diff Entry

Show Child Parameters
Example

Branch With Protection

object

Branch With Protection

namestringrequired
commitobjectrequired

Commit

Show Child Parameters
_linksobjectrequired
Show Child Parameters
protectedbooleanrequired
protectionobjectrequired

Branch Protection

Show Child Parameters
protection_urlstring(uri)required
patternstring

Example:"mas*"

required_approving_review_countinteger

Example:1

Example

Status Check Policy

object

Status Check Policy

urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks

strictbooleanrequired

Example:true

contextsarray[string]required

Example:continuous-integration/travis-ci

contexts_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts

Example

Protected Branch

object

Branch protections protect branches

urlstring(uri)required
required_status_checksobject

Status Check Policy

Show Child Parameters
required_pull_request_reviewsobject
Show Child Parameters
required_signaturesobject
Show Child Parameters
enforce_adminsobject
* Additional properties are NOT allowed.
Show Child Parameters
required_linear_historyobject
* Additional properties are NOT allowed.
Show Child Parameters
allow_force_pushesobject
* Additional properties are NOT allowed.
Show Child Parameters
allow_deletionsobject
* Additional properties are NOT allowed.
Show Child Parameters
restrictionsobject

Branch Restriction Policy

Show Child Parameters
required_conversation_resolutionobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

Deployment

object

A deployment created as the result of an Actions check run from a workflow that references an environment

urlstring(uri)required

Example:https://api.github.com/repos/octocat/example/deployments/1

idintegerrequired

Unique identifier of the deployment

Example:42

node_idstringrequired

Example:MDEwOkRlcGxveW1lbnQx

taskstringrequired

Parameter to specify a task to execute

Example:deploy

original_environmentstring

Example:staging

environmentstringrequired

Name for the target deployment environment.

Example:production

descriptionstringrequired

Example:Deploy request from hubot

created_atstring(date-time)required

Example:2012-07-20T01:19:13Z

updated_atstring(date-time)required

Example:2012-07-20T01:19:13Z

statuses_urlstring(uri)required

Example:https://api.github.com/repos/octocat/example/deployments/1/statuses

repository_urlstring(uri)required

Example:https://api.github.com/repos/octocat/example

transient_environmentboolean

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

Example:true

production_environmentboolean

Specifies if the given environment is one that end-users directly interact with. Default: false.

Example:true

performed_via_github_appobject

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

Show Child Parameters
Example