알림

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

알림 정보

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

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

상태 코드	Description
`200`	OK

get/enterprise/announcement

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://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
}

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

헤더
속성, 형식, 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.

상태 코드	Description
`200`	OK

patch/enterprise/announcement

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://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
}

Removes the global announcement banner in your enterprise.

상태 코드	Description
`204`	No Content

delete/enterprise/announcement

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

Response

Status: 204

알림

알림 정보

Get the global announcement banner

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

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

Set the global announcement banner

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

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

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

Remove the global announcement banner

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

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