GitHub v3 REST API

Deployment Status

object

The status of a deployment.

urlstring(uri)required

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

idintegerrequired

Example:1

node_idstringrequired

Example:MDE2OkRlcGxveW1lbnRTdGF0dXMx

statestringrequired

The state of the status.

Allowed values:errorfailureinactivependingsuccessqueuedin_progress

Example:success

creatorobjectrequired

Simple User

Show Child Parameters
descriptionstringrequired

A short description of the status.

Default:

<= 140 characters

Example:Deployment finished successfully.

environmentstring

The environment of the deployment that the status is for.

Default:

Example:production

target_urlstring(uri)required

Deprecated: the URL to associate with this status.

Default:

Example:https://example.com/deployment/42/output

created_atstring(date-time)required

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

updated_atstring(date-time)required

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

deployment_urlstring(uri)required

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

repository_urlstring(uri)required

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

environment_urlstring(uri)

The URL for accessing your environment.

Default:

Example:https://staging.example.com/

log_urlstring(uri)

The URL to associate with this status.

Default:

Example:https://example.com/deployment/42/output

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

Short Blob

object

Short Blob

urlstringrequired
shastringrequired
Example

Blob

object

Blob

contentstringrequired
encodingstringrequired
urlstring(uri)required
shastringrequired
sizeintegerrequired
node_idstringrequired
highlighted_contentstring
Example

Git Commit

object

Low-level Git commit operations within a repository

shastringrequired

SHA for the commit

Example:7638417db6d59f3c431d3e1f261cc637155684cd

node_idstringrequired
urlstring(uri)required
authorobjectrequired

Identifying information for the git-user

Show Child Parameters
committerobjectrequired

Identifying information for the git-user

Show Child Parameters
messagestringrequired

Message describing the purpose of the commit

Example:Fix #42

treeobjectrequired
Show Child Parameters
parentsarray[object]required
Show Child Parameters
verificationobjectrequired
Show Child Parameters
html_urlstring(uri)required
Example

Git Reference

object

Git references within a repository

refstringrequired
node_idstringrequired
urlstring(uri)required
objectobjectrequired
Show Child Parameters
Example