GitHub v3 REST API

Get the global announcement banner

Gets the current message and expiration date of the global announcement banner in your enterprise.

get
http://HOSTNAME/api/v3/enterprise/announcement

Response

200 application/json

Response

Enterprise Announcement

Enterprise global announcement

announcementstringrequired

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see “Basic writing and formatting syntax.”

Example:Very **important** announcement about _nothing_.

expires_atstring | null(date-time)

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

Example:"2021-01-01T00:00:00.000-07:00"

get/enterprise/announcement
 
200 application/json

Set the global announcement banner

Sets the message and expiration time for the global announcement banner in your enterprise.

patch
http://HOSTNAME/api/v3/enterprise/announcement

Body

application/json

Enterprise Announcement

Enterprise global announcement

announcementstringrequired

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see “Basic writing and formatting syntax.”

Example:Very **important** announcement about _nothing_.

expires_atstring | null(date-time)

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

Example:"2021-01-01T00:00:00.000-07:00"

Response

200 application/json

Response

Enterprise Announcement

Enterprise global announcement

announcementstringrequired

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see “Basic writing and formatting syntax.”

Example:Very **important** announcement about _nothing_.

expires_atstring | null(date-time)

The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

Example:"2021-01-01T00:00:00.000-07:00"

patch/enterprise/announcement

Body

{ "announcement": "Very **important** announcement about _nothing_." }
 
200 application/json

Remove the global announcement banner

Removes the global announcement banner in your enterprise.

delete
http://HOSTNAME/api/v3/enterprise/announcement

Response

204

Response

delete/enterprise/announcement
 
204

Get license information

get
http://HOSTNAME/api/v3/enterprise/settings/license

Response

200 application/json

Response

license-info

seatsOne Of
Variant 1string
seats_usedinteger
seats_availableOne Of
Variant 1string
kindstring
days_until_expirationinteger
expire_atstring
get/enterprise/settings/license
 
200 application/json

Get all statistics

get
http://HOSTNAME/api/v3/enterprise/stats/all

Response

200 application/json

Response

enterprise-overview

reposobject
Show Child Parameters
hooksobject
Show Child Parameters
pagesobject
Show Child Parameters
orgsobject
Show Child Parameters
usersobject
Show Child Parameters
pullsobject
Show Child Parameters
issuesobject
Show Child Parameters
milestonesobject
Show Child Parameters
gistsobject
Show Child Parameters
commentsobject
Show Child Parameters
get/enterprise/stats/all
 
200 application/json