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

엔터프라이즈 알림 배너에 대한 REST API 엔드포인트

엔터프라이즈 공지 배너 API를 사용하면 엔터프라이즈의 알림 배너를 받아서 설정하고 제거할 수 있습니다.

Get announcement banner for enterprise

Gets the announcement banner currently set for the enterprise.

"Get announcement banner for enterprise"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Get announcement banner for enterprise"에 대한 매개 변수

헤더
이름, Type, 설명
accept string

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

경로 매개 변수
이름, Type, 설명
enterprise string Required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

"Get announcement banner for enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Get announcement banner for enterprise"에 대한 코드 샘플

요청 예제

get/enterprises/{enterprise}/announcement
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/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 announcement banner for enterprise

Sets the announcement banner to display for the enterprise.

"Set announcement banner for enterprise"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Set announcement banner for enterprise"에 대한 매개 변수

헤더
이름, Type, 설명
accept string

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

경로 매개 변수
이름, Type, 설명
enterprise string Required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

본문 매개 변수
이름, Type, 설명
announcement string or null Required

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 announcement banner for enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

"Set announcement banner for enterprise"에 대한 코드 샘플

요청 예제

patch/enterprises/{enterprise}/announcement
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/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 enterprise

Removes the announcement banner currently set for the enterprise.

"Remove announcement banner from enterprise"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Remove announcement banner from enterprise"에 대한 매개 변수

헤더
이름, Type, 설명
accept string

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

경로 매개 변수
이름, Type, 설명
enterprise string Required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

"Remove announcement banner from enterprise"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

"Remove announcement banner from enterprise"에 대한 코드 샘플

요청 예제

delete/enterprises/{enterprise}/announcement
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/announcement

Response

Status: 204