Skip to main content

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.

公告

公告 API 使你能够管理企业中的全局公告横幅。

公告

公告 API 允许您管理企业中的全局公告横幅。 有关详细信息,请参阅“为企业自定义用户消息”。

Get the global announcement banner

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

HTTP 响应状态代码

状态代码说明
200

OK

代码示例

get/enterprise/announcement
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/enterprise/announcement

Default response

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

Set the global announcement banner

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

参数

Headers
Name, Type, Description
acceptstring

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

Body parameters
Name, Type, Description
announcementstringRequired

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax."

expires_atstring 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 响应状态代码

状态代码说明
200

OK

代码示例

patch/enterprise/announcement
curl \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/enterprise/announcement

Default response

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

Remove the global announcement banner

Removes the global announcement banner in your enterprise.

HTTP 响应状态代码

状态代码说明
204

No Content

代码示例

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

Response

Status: 204