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.

アナウンス

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

アナウンス

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

Get the global announcement banner

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

HTTP response status codes

Status code説明
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" }

Set the global announcement banner

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

パラメータ

Headers
名前, 種類, 説明
acceptstring

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

Body parameters
名前, 種類, 説明
announcementstring必須

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 response status codes

Status code説明
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" }

Remove the global announcement banner

Removes the global announcement banner in your enterprise.

HTTP response status codes

Status code説明
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