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.
告知
アナウンス API を使うと、Enterprise でのグローバルなアナウンス バナーを管理できます。
告知
アナウンス API を使用すると、Enterprise でグローバルなアナウンスバナーを管理できます。 詳細については、「エンタープライズのユーザー メッセージをカスタマイズする」を参照してください。
Get the global announcement banner
Gets the current message and expiration date of the global announcement banner in your enterprise.
HTTP 応答状態コード
| status code | 説明 |
|---|---|
200 | OK |
コード サンプル
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/enterprise/announcementDefault 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 |
|---|
| Name, Type, Description |
acceptstringSetting to |
| Body parameters |
| Name, Type, Description |
announcementstringRequiredThe 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: |
HTTP 応答状態コード
| status code | 説明 |
|---|---|
200 | OK |
コード サンプル
curl \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/enterprise/announcementDefault response
Status: 200{
"announcement": "Very **important** announcement about _nothing_.",
"expires_at": "2021-01-01T00:00:00.000+00:00"
}Remove the global announcement banner
コード サンプル
curl \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/enterprise/announcementResponse
Status: 204