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

Баннеры объявлений организации

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

Get announcement banner for organization

Работа с GitHub Apps

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the organization level. Organization members may also see an enterprise-level announcement banner. To get an announcement banner displayed at the enterprise level, use the enterprise-level endpoint.

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

Заголовки
accept string

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

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

The organization name. The name is not case sensitive.

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

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

OK

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

get/orgs/{org}/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/orgs/ORG/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 organization

Работа с GitHub Apps

Sets the announcement banner to display for the organization.

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

Заголовки
accept string

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

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

The organization name. The name is not case sensitive.

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

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

OK

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

patch/orgs/{org}/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/orgs/ORG/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 organization

Работа с GitHub Apps

Removes the announcement banner currently set for the organization.

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

Заголовки
accept string

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

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

The organization name. The name is not case sensitive.

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

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

No Content

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

delete/orgs/{org}/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/orgs/ORG/announcement

Response

Status: 204