アナウンス

Announcement API を使用すると、Enterprise でグローバルなアナウンスバナーを管理できます。

アナウンス

Announcement API を使用すると、Enterprise でグローバルなアナウンスバナーを管理できます。詳しい情報については「Enterprise のユーザメッセージをカスタマイズする」を参照してください。

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

Status code	説明
`200`	OK

get/enterprise/announcement

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

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Body parameters
名前, 種類, 説明
`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.

Status code	説明
`200`	OK

patch/enterprise/announcement

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

Status code	説明
`204`	No Content

delete/enterprise/announcement

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

Response

Status: 204

アナウンス