Объявление

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

About announcements

You can use the REST API to manage the global announcement banner in your enterprise. For more information, see "Customizing user messages for your enterprise."

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

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

get/enterprise/announcement

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  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.

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры запроса
Имя, Тип, Описание
`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>" \
  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>" \
  http(s)://HOSTNAME/api/v3/enterprise/announcement

Response

Status: 204

Объявление

About announcements

Get the global announcement banner

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

Примеры кода для "Get 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"

Remove the global announcement banner

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

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