Конечные точки REST API для глобальных объявлений

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

О объявлениях

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

Эти конечные точки поддерживают проверку подлинности только с помощью personal access token (classic). Дополнительные сведения см. в разделе Управление личными маркерами доступа.

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

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

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

Пример запроса

get/enterprise/announcement

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://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
}

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

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры запроса
Имя., Тип, Description
`announcement` string or null Обязательное поле The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax."
`expires_at` string 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.

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

Пример запроса

patch/enterprise/announcement

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://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
}

Removes the global announcement banner in your enterprise.

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

Пример запроса

delete/enterprise/announcement

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprise/announcement

Response

Status: 204

Конечные точки REST API для глобальных объявлений

О объявлениях

Get the global announcement banner

Подробные маркеры доступа для "Get the global announcement banner

Коды состояния http-ответа для "Get the global announcement banner"

Примеры кода для "Get the global announcement banner"

Пример запроса

Announcement banner

Set the global announcement banner

Подробные маркеры доступа для "Set the global announcement banner

Параметры для "Set the global announcement banner"

Коды состояния http-ответа для "Set the global announcement banner"

Примеры кода для "Set the global announcement banner"

Пример запроса

Announcement banner

Remove the global announcement banner

Подробные маркеры доступа для "Remove the global announcement banner

Коды состояния http-ответа для "Remove the global announcement banner"

Примеры кода для "Remove the global announcement banner"

Пример запроса

Response