GitHub v3 REST API

Delete a global webhook

delete
{protocol}://{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

204

Response

delete/admin/hooks/{hook_id}
 
204

Ping a global webhook

This will trigger a ping event to be sent to the webhook.

post
{protocol}://{hostname}/api/v3/admin/hooks/{hook_id}/pings

Path Parameters

hook_idintegerrequired

Headers

acceptstringrequired

This API is under preview and subject to change.

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

Response

204

Response

post/admin/hooks/{hook_id}/pings
 
204

List public keys

get
{protocol}://{hostname}/api/v3/admin/keys

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

directionstring

One of asc (ascending) or desc (descending).

Allowed values:ascdesc

Default:desc

sortstring

Allowed values:createdupdatedaccessed

Default:created

sincestring

Only show public keys accessed after the given time.

Response

200 application/json

Response

idintegerrequired
keystringrequired
user_idinteger | nullrequired
repository_idinteger | nullrequired
urlstringrequired
titlestringrequired
read_onlybooleanrequired
verifiedbooleanrequired
created_atstring(date-time)required
last_usedstring | null(date-time)required
get/admin/keys
 
200 application/json

Delete a public key

delete
{protocol}://{hostname}/api/v3/admin/keys/{key_ids}

Path Parameters

key_idsstringrequired

Response

204

Response

delete/admin/keys/{key_ids}
 
204

Update LDAP mapping for a team

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

If you pass the hellcat-preview media type, you can also update the LDAP mapping of a child team.

patch
{protocol}://{hostname}/api/v3/admin/ldap/teams/{team_id}/mapping

Path Parameters

team_idintegerrequired

Body

application/json
ldap_dnstringrequired

The distinguished name (DN) of the LDAP entry to map to a team.

Response

200 application/json

Response

ldap-mapping-team

ldap_dnstring
idinteger
node_idstring
urlstring
html_urlstring
namestring
slugstring
descriptionstring | null
privacystring
permissionstring
members_urlstring
repositories_urlstring
parent
patch/admin/ldap/teams/{team_id}/mapping

Body

{ "ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" }
 
200 application/json