GitHub v3 REST API

GitHub Pages

object

The configuration for GitHub Pages for a repository.

urlstring(uri)required

The API address for accessing this Page resource.

Example:https://api.github.com/repos/github/hello-world/pages

statusstringrequired

The status of the most recent build of the Page.

Allowed values:builtbuildingerrored

Example:built

cnamestringrequired

The Pages site’s custom domain

Example:example.com

protected_domain_statestring

The state if the domain is verified

Allowed values:pendingverifiedunverified

Example:pending

pending_domain_unverified_atstring(date-time)

The timestamp when a pending domain becomes unverified.

custom_404booleanrequired

Whether the Page has a custom 404 page.

Default:false

html_urlstring(uri)

The web address the Page can be accessed from.

Example:https://example.com

sourceobject
Show Child Parameters
publicbooleanrequired

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.

Example:true

https_certificateobject
Show Child Parameters
https_enforcedboolean

Whether https is enabled on the domain

Example:true

Example

Page Build

object

Page Build

urlstring(uri)required
statusstringrequired
errorobjectrequired
Show Child Parameters
pusherobjectrequired

Simple User

Show Child Parameters
commitstringrequired
durationintegerrequired
created_atstring(date-time)required
updated_atstring(date-time)required
Example

Page Build Status

object

Page Build Status

urlstring(uri)required

Example:https://api.github.com/repos/github/hello-world/pages/builds/latest

statusstringrequired

Example:queued

Example

repository-pre-receive-hook

object
idinteger
namestring
enforcementstring
configuration_urlstring
Example

Team Simple

object

Groups of organization members that gives permissions on specified repositories.

idintegerrequired

Unique identifier of the team

Example:1

node_idstringrequired

Example:MDQ6VGVhbTE=

urlstring(uri)required

URL for the team

Example:https://api.github.com/organizations/1/team/1

members_urlstringrequired

Example:https://api.github.com/organizations/1/team/1/members{/member}

namestringrequired

Name of the team

Example:Justice League

descriptionstringrequired

Description of the team

Example:A great team.

permissionstringrequired

Permission that the team will have for its repositories

Example:admin

privacystring

The level of privacy this team should have

Example:closed

html_urlstring(uri)required

Example:https://github.com/orgs/rails/teams/core

repositories_urlstring(uri)required

Example:https://api.github.com/organizations/1/team/1/repos

slugstringrequired

Example:justice-league

ldap_dnstring

Distinguished Name (DN) that team maps to within LDAP environment

Example:uid=example,ou=users,dc=github,dc=com

Example