Enterprise Server 3.21 은(는) 현재 릴리스 후보로 제공됩니다.

이제 REST API의 버전이 지정되었습니다. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

조직 알림 배너에 대한 REST API 엔드포인트

조직 공지 배너 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: 2026-03-10" \ 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: 2026-03-10" \ 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: 2026-03-10" \ http(s)://HOSTNAME/api/v3/orgs/ORG/announcement

Response

Status: 204