Die REST-API verfügt jetzt über eine Versionskontrolle. 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 finden Sie unter Anpassen von Benutzernachrichten für dein Unternehmen.

Note

Diese Endpunkte unterstützen nur die Authentifizierung über ein personal access token (classic). Weitere Informationen findest du unter Verwalten deiner persönlichen Zugriffstoken.

Get the global announcement banner

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

Differenzierte Zugriffstoken für "Get the global announcement banner"

Dieser Endpunkt funktioniert nicht mit GitHub-App-Benutzerzugriffstoken, GitHub-App-Installationszugriffstoken oder differenzierten persönlichen Zugriffstoken.

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

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für „Get the global announcement banner“

Anforderungsbeispiel

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

Differenzierte Zugriffstoken für "Set the global announcement banner"

Dieser Endpunkt funktioniert nicht mit GitHub-App-Benutzerzugriffstoken, GitHub-App-Installationszugriffstoken oder differenzierten persönlichen Zugriffstoken.

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“

Anforderungsbeispiel

patch/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" \ 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.

Differenzierte Zugriffstoken für "Remove the global announcement banner"

Dieser Endpunkt funktioniert nicht mit GitHub-App-Benutzerzugriffstoken, GitHub-App-Installationszugriffstoken oder differenzierten persönlichen Zugriffstoken.

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

StatuscodeBESCHREIBUNG
204

No Content

Codebeispiele für „Remove the global announcement banner“

Anforderungsbeispiel

delete/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" \ http(s)://HOSTNAME/api/v3/enterprise/announcement

Response

Status: 204