このバージョンの GitHub Enterprise サーバーはこの日付をもって終了となります: 2026-06-02. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise サーバーにアップグレードしてください。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください。

REST API はバージョン化されました。 詳細については、「API のバージョン管理について」を参照してください。

組織のお知らせバナー用 REST API エンドポイント

Organization Announcement Banners API を使って、組織のお知らせバナーを取得、設定、削除できます。

Get announcement banner for organization

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the organization level. Organization members may also see an enterprise-level announcement banner. To get an announcement banner displayed at the enterprise level, use the enterprise-level endpoint.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

  • "Organization announcement banners" organization permissions (read)

"Get announcement banner for organization" のパラメーター

ヘッダー
accept string

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

パスパラメーター
org string 必須

The organization name. The name is not case sensitive.

http_status_code

status_code説明
200

OK

code_samples

request_example

get/orgs/{org}/announcement
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/orgs/ORG/announcement

Announcement banner

Status: 200
{ "announcement": "Very **important** announcement about _something_.", "expires_at": "2021-01-01T00:00:00.000+00:00", "user_dismissible": false }

Set announcement banner for organization

Sets the announcement banner to display for the organization.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

  • "Organization announcement banners" organization permissions (write)

"Set announcement banner for organization" のパラメーター

ヘッダー
accept string

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

パスパラメーター
org string 必須

The organization name. The name is not case sensitive.

ボディパラメータ
announcement string or null 必須

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.

user_dismissible boolean or null

Whether an announcement can be dismissed by the user.

デフォルト: false

http_status_code

status_code説明
200

OK

code_samples

request_example

patch/orgs/{org}/announcement
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/orgs/ORG/announcement \ -d '{"announcement":"Very **important** announcement about _something_.","expires_at":"2021-01-01T00:00:00.000+00:00","user_dismissible":false}'

Announcement banner

Status: 200
{ "announcement": "Very **important** announcement about _something_.", "expires_at": "2021-01-01T00:00:00.000+00:00", "user_dismissible": false }

Remove announcement banner from organization

Removes the announcement banner currently set for the organization.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

  • "Organization announcement banners" organization permissions (write)

"Remove announcement banner from organization" のパラメーター

ヘッダー
accept string

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

パスパラメーター
org string 必須

The organization name. The name is not case sensitive.

http_status_code

status_code説明
204

No Content

code_samples

request_example

delete/orgs/{org}/announcement
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/orgs/ORG/announcement

Response

Status: 204