Search
K
GitHub v3 REST API

Git Reference

object

Git references within a repository

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

Git Tag

object

Metadata for a Git tag

node_idstringrequired

Example:MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==

tagstringrequired

Name of the tag

Example:v0.0.1

shastringrequired

Example:940bd336248efae0f9ee5bc7b2d5c985887b16ac

urlstring(uri)required

URL for the tag

Example:https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac

messagestringrequired

Message describing the purpose of the tag

Example:Initial public release

taggerobjectrequired
Show Child Parameters
objectobjectrequired
Show Child Parameters
verificationobject
Show Child Parameters
Example

Git Tree

object

The hierarchy between files in a Git repository.

shastringrequired
urlstring(uri)required
truncatedbooleanrequired
treearray[object]required

Objects specifying a tree structure

Example:{"path":"file.rb","mode":"100644","type":"blob","size":30,"sha":"44b4fc6d56897b048c772eb4087f854f46256132","url":"https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132","properties":{"path":{"type":"string"},"mode":{"type":"string"},"type":{"type":"string"},"size":{"type":"integer"},"sha":{"type":"string"},"url":{"type":"string"}},"required":["path","mode","type","sha","url","size"]}

Show Child Parameters
Example

Hook Response

object
codeintegerrequired
statusstringrequired
messagestringrequired
Example

Webhook

object

Webhooks for repositories.

typestringrequired
idintegerrequired

Unique identifier of the webhook.

Example:42

namestringrequired

The name of a valid service, use ‘web’ for a webhook.

Example:web

activebooleanrequired

Determines whether the hook is actually triggered on pushes.

Example:true

eventsarray[string]required

Determines what events the hook is triggered for. Default: [‘push’].

Example:push, pull_request

configobjectrequired
Show Child Parameters
updated_atstring(date-time)required

Example:2011-09-06T20:39:23Z

created_atstring(date-time)required

Example:2011-09-06T17:26:27Z

urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/hooks/1

test_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/hooks/1/test

ping_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/hooks/1/pings

last_responseobjectrequired
Show Child Parameters
Example