GitHub v3 REST API

Get a code of conduct

get
http://HOSTNAME/api/v3/codes_of_conduct/{key}

Path Parameters

keystringrequired

Response

application/json

Response

Code Of Conduct

Code Of Conduct

keystringrequired

Example:contributor_covenant

namestringrequired

Example:Contributor Covenant

urlstring(uri)required

Example:https://api.github.com/codes_of_conduct/contributor_covenant

bodystring

Example:# Contributor Covenant Code of Conduct ## Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Gracefully accepting constructive criticism * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] [homepage]: http://contributor-covenant.org [version]: http://contributor-covenant.org/version/1/4/

html_urlstring | null(uri)required
get/codes_of_conduct/{key}
 
application/json

Get emojis

Lists all the emojis available to use on GitHub Enterprise Server.

get
http://HOSTNAME/api/v3/emojis

Response

application/json

Response

object
get/emojis
 
application/json

List global webhooks

get
http://HOSTNAME/api/v3/admin/hooks

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Headers

acceptstringrequired

This API is under preview and subject to change.

Default:application/vnd.github.superpro-preview+json

Response

200 application/json

Response

typestring
idinteger
namestring
activeboolean
eventsarray[string]
configobject
Show Child Parameters
updated_atstring
created_atstring
urlstring
ping_urlstring
get/admin/hooks
 
200 application/json

Create a global webhook

post
http://HOSTNAME/api/v3/admin/hooks

Headers

acceptstringrequired

This API is under preview and subject to change.

Default:application/vnd.github.superpro-preview+json

Body

application/json
namestringrequired

Must be passed as “web”.

configobjectrequired

Key/value pairs to provide settings for this webhook.

Show Child Parameters
eventsarray[string]

The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.

activeboolean

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

Default:true

Response

201 application/json

Response

global-hook

typestring
idinteger
namestring
activeboolean
eventsarray[string]
configobject
Show Child Parameters
updated_atstring
created_atstring
urlstring
ping_urlstring
post/admin/hooks

Body

{ "name": "web", "events": [ "organization", "user" ], "config": { "url": "https://example.com/webhook", "content_type": "json", "secret": "secret" } }
 
201 application/json

Get a global webhook

get
http://HOSTNAME/api/v3/admin/hooks/{hook_id}

Path Parameters

hook_idintegerrequired

Headers

acceptstringrequired

This API is under preview and subject to change.

Default:application/vnd.github.superpro-preview+json

Response

200 application/json

Response

global-hook

typestring
idinteger
namestring
activeboolean
eventsarray[string]
configobject
Show Child Parameters
updated_atstring
created_atstring
urlstring
ping_urlstring
get/admin/hooks/{hook_id}
 
200 application/json