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 |
コードサンプル
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"
}
Set the global announcement banner
Sets the message and expiration time for the global announcement banner in your enterprise.
パラメータ
Headers |
---|
名前, 種類, 説明 |
accept stringSetting to |
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 nullThe time at which the announcement expires. This is a timestamp in ISO 8601 format: |
HTTP response status codes
Status code | 説明 |
---|---|
200 | OK |
コードサンプル
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"
}
Remove the global announcement banner
Removes the global announcement banner in your enterprise.
HTTP response status codes
Status code | 説明 |
---|---|
204 | No Content |
コードサンプル
curl \
-X DELETE \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/enterprise/announcement
Response
Status: 204