公告 - GitHub Enterprise Server 3.3 Docs

公告

公告 API 允许您管理企业中的全局公告横幅。

公告

公告 API 允许您管理企业中的全局公告横幅。更多信息请参阅“自定义企业的用户消息”。

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

状态代码	描述
`200`	OK

get/enterprise/announcement

curl \
  -H "Accept: application/vnd.github+json" \ 
  -H "Authorization: token <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"
}

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

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github+json` is recommended.
正文参数
名称, 类型, 描述
`announcement`string必选 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.

状态代码	描述
`200`	OK

patch/enterprise/announcement

curl \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \ 
  -H "Authorization: token <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"
}

Removes the global announcement banner in your enterprise.

状态代码	描述
`204`	No Content

delete/enterprise/announcement

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

Response

Status: 204

公告

公告

Get the global announcement banner

HTTP 响应状态代码

代码示例

Default response

Set the global announcement banner

参数

HTTP 响应状态代码

代码示例

Default response

Remove the global announcement banner

HTTP 响应状态代码

代码示例

Response