REST API 现已开始进行版本化。 有关详细信息，请参阅“关于 API 版本控制”。

适用于全球公告的 REST API 终结点

使用 REST API 管理企业中的全局公告横幅。

关于公告

可以使用 REST API 管理企业中的全局公告横幅。 有关详细信息，请参阅“自定义企业的用户消息”。

注意

这些终结点仅支持使用 personal access token (classic) 进行身份验证。 有关详细信息，请参阅“管理个人访问令牌”。

Get the global announcement banner

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

fine_grained_access

no_fine_grained_access

http_status_code

status_code说明
200

OK

code_samples

request_example

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 }

Set the global announcement banner

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

fine_grained_access

no_fine_grained_access

“”Set the global announcement banner 的参数

标头
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.

user_dismissible boolean or null

Whether an announcement can be dismissed by the user.

默认: false

http_status_code

status_code说明
200

OK

code_samples

request_example

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 }

Remove the global announcement banner

Removes the global announcement banner in your enterprise.

fine_grained_access

no_fine_grained_access

http_status_code

status_code说明
204

No Content

code_samples

request_example

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