Skip to main content

This version of GitHub Enterprise was discontinued on 2022-06-03. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.

Announcement

The Announcement API allows you to manage the global announcement banner in your enterprise.

Announcement

The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "Customizing user messages for your enterprise."

Get the global announcement banner

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

HTTP response status codes

Status codeDescription
200

OK

Code samples

get/enterprise/announcement
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/enterprise/announcement

Default response

Status: 200
{ "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" }

Set the global announcement banner

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

Parameters

Headers
Name, Type, Description
acceptstring

Setting to application/vnd.github.v3+json is recommended.

Body parameters
Name, Type, Description
announcementstringRequired

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

expires_atstring or null

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.

HTTP response status codes

Status codeDescription
200

OK

Code samples

patch/enterprise/announcement
curl \ -X PATCH \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/enterprise/announcement

Default response

Status: 200
{ "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" }

Remove the global announcement banner

Removes the global announcement banner in your enterprise.

HTTP response status codes

Status codeDescription
204

No Content

Code samples

delete/enterprise/announcement
curl \ -X DELETE \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/enterprise/announcement

Response

Status: 204