Skip to main content
我们经常发布文档更新，此页面的翻译可能仍在进行中。 有关最新信息，请访问英语文档。
GitHub AE 目前处于受限版。
All products
REST API

我们最近移动了一些 REST API 文档。 如果找不到要查找的内容，可以尝试 操作 REST API 页面。

公告

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

关于公告

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

Get the global announcement banner

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

“Get the global announcement banner”的 HTTP 响应状态代码

状态代码说明
200

OK

“Get the global announcement banner”的示例代码

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

“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.

“Set the global announcement banner”的 HTTP 响应状态代码

状态代码说明
200

OK

“Set the global announcement banner”的示例代码

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

“Remove the global announcement banner”的 HTTP 响应状态代码

状态代码说明
204

No Content

“Remove the global announcement banner”的示例代码

delete/enterprise/announcement
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://HOSTNAME/api/v3/enterprise/announcement

Response

Status: 204