Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы, возможно, еще выполняется. Актуальные сведения см. в документации на английском языке.
All products
REST API
REST API теперь имеет версию. Дополнительные сведения см. в разделе Сведения об управлении версиями API.

Баннеры объявлений enterprise

API "Корпоративные баннеры объявлений" позволяет получать, настраивать и удалять баннеры объявлений для вашего предприятия.

Get announcement banner for enterprise

Gets the announcement banner currently set for the enterprise.

Параметры для "Get announcement banner for enterprise"

Заголовки
accept string

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

Параметры пути
enterprise string Обязательно

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

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

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

OK

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

get/enterprises/{enterprise}/announcement
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/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 announcement banner for enterprise

Sets the announcement banner to display for the enterprise.

Параметры для "Set announcement banner for enterprise"

Заголовки
accept string

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

Параметры пути
enterprise string Обязательно

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Параметры запроса
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.

Коды состояния HTTP-ответа для "Set announcement banner for enterprise"

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

OK

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

patch/enterprises/{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" \ https://api.github.com/enterprises/ENTERPRISE/announcement \ -d '{"announcement":"Very **important** announcement about _something_.","expires_at":"2021-01-01T00:00:00.000+00:00","user_dismissible":false}'

Announcement banner

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

Remove announcement banner from enterprise

Removes the announcement banner currently set for the enterprise.

Параметры для "Remove announcement banner from enterprise"

Заголовки
accept string

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

Параметры пути
enterprise string Обязательно

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

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

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

No Content

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

delete/enterprises/{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" \ https://api.github.com/enterprises/ENTERPRISE/announcement

Response

Status: 204