Diese Version von GitHub Enterprise Server wurde eingestellt am 2024-03-26. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für bessere Leistung, verbesserte Sicherheit und neue Features aktualisiere auf die neueste Version von GitHub Enterprise Server. Wende dich an den GitHub Enterprise-Support, um Hilfe zum Upgrade zu erhalten.

Nachdem deine Enterprise Server-Instanz durch Websiteadministrator*innen auf Enterprise Server 3.9 oder höher aktualisiert wurde, erhält die REST-API eine Versionskontrolle. Weitere Informationen zum Ermitteln der Version deiner Instanz findest du unter Informationen zu Versionen der GitHub-Dokumentation. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

REST-API-Endpunkte für globale Ankündigungen

Verwende die REST-API, um das globale Ankündigungsbanner in deinem Unternehmen zu verwalten.

Informationen zu Ankündigungen

Du kannst die REST-API verwenden, um das globale Ankündigungsbanner in deinem Unternehmen zu verwalten. Weitere Informationen findest du unter Anpassen von Benutzernachrichten für dein Unternehmen.

Get the global announcement banner

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

HTTP-Antwortstatuscodes für „Get the global announcement banner“

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für „Get the global announcement banner“

Beispiel für eine Anfrage

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.

Parameter für „Set the global announcement banner“

Header
accept string

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

Textparameter
announcement string or null Erforderlich

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.

HTTP-Antwortstatuscodes für „Set the global announcement banner“

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für „Set the global announcement banner“

Beispiel für eine Anfrage

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.

HTTP-Antwortstatuscodes für „Remove the global announcement banner“

StatuscodeBESCHREIBUNG
204

No Content

Codebeispiele für „Remove the global announcement banner“

Beispiel für eine Anfrage

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