Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.
В настоящее время GitHub AE находится в ограниченном выпуске.

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.

Объявление

Используйте REST API для управления баннером глобального объявления на предприятии.

Сведения об объявлениях

Вы можете использовать REST API для управления баннером глобального объявления на предприятии. Дополнительные сведения см. в разделе Настройка сообщений для пользователей на предприятии.

Get the global announcement banner

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

Коды состояния HTTP-ответа

Код состоянияОписание
200

OK

Примеры кода

get/enterprise/announcement
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/enterprise/announcement

Announcement banner

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

Set the global announcement banner

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

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

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

Параметры запроса
Имя, Тип, Описание
announcementstring or nullОбязательно

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-ответа

Код состоянияОписание
200

OK

Примеры кода

patch/enterprise/announcement
curl \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/enterprise/announcement \ -d '{"announcement":"Very **important** announcement about _something_.","expires_at":"2021-01-01T00:00:00.000+00:00"}'

Announcement banner

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

Remove the global announcement banner

Removes the global announcement banner in your enterprise.

Коды состояния HTTP-ответа

Код состоянияОписание
204

No Content

Примеры кода

delete/enterprise/announcement
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/enterprise/announcement

Response

Status: 204