Skip to main content
설명서에 자주 업데이트를 게시하며 이 페이지의 번역이 계속 진행 중일 수 있습니다. 최신 정보는 영어 설명서를 참조하세요.
사이트 관리자가 엔터프라이즈 서버 instance Enterprise Server 3.9 이상으로 업그레이드하면 REST API의 버전이 지정됩니다. instance 버전을 찾는 방법을 알아보려면 "GitHub Docs 버전 정보"를 참조하세요. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

알림

REST API를 사용하여 엔터프라이즈에서 전역 알림 배너를 관리합니다.

알림 정보

REST API를 사용하여 엔터프라이즈에서 전역 알림 배너를 관리할 수 있습니다. 자세한 내용은 "엔터프라이즈에 대한 사용자 메시지 사용자 지정"을 참조하세요.

Get the global announcement banner

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

"Get the global announcement banner"에 대한 HTTP 응답 상태 코드

상태 코드Description
200

OK

"Get the global announcement banner"에 대한 코드 샘플

get/enterprise/announcement
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/enterprise/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 the global announcement banner

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

"Set the global announcement banner"에 대한 매개 변수

헤더
속성, 형식, Description
accept string

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

본문 매개 변수
속성, 형식, Description
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.

"Set the global announcement banner"에 대한 HTTP 응답 상태 코드

상태 코드Description
200

OK

"Set the global announcement banner"에 대한 코드 샘플

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

Announcement banner

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

Remove the global announcement banner

Removes the global announcement banner in your enterprise.

"Remove the global announcement banner"에 대한 HTTP 응답 상태 코드

상태 코드Description
204

No Content

"Remove the global announcement banner"에 대한 코드 샘플

delete/enterprise/announcement
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/enterprise/announcement

Response

Status: 204