我们最近移动了一些 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”的示例代码
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprise/announcementAnnouncement 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”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
acceptstringSetting to |
| 正文参数 |
| 名称, 类型, 说明 |
announcementstring or null必选The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax." |
expires_atstring or nullThe time at which the announcement expires. This is a timestamp in ISO 8601 format: |
“Set the global announcement banner”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
“Set the global announcement banner”的示例代码
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
“Remove the global announcement banner”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
204 | No Content |
“Remove the global announcement banner”的示例代码
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprise/announcementResponse
Status: 204