Die REST-API ist jetzt versioniert. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

REST-API-Endpunkte für Ankündigungsbanner für Unternehmen

Mithilfe der API für Banner mit Unternehmensankündigungen kannst du das Ankündigungsbanner für dein Unternehmen abrufen, festlegen und entfernen.

Get announcement banner for enterprise

Gets the announcement banner currently set for the enterprise.

Feinkörnige Zugriffstoken für "Get announcement banner for enterprise"

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

Parameter für "Get announcement banner for enterprise"

Header
accept string

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

Pfadparameter
enterprise string Erforderlich

The slug version of the enterprise name.

HTTP-Antwortstatuscodes für "Get announcement banner for enterprise"

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für "Get announcement banner for enterprise"

Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com.

Anforderungsbeispiel

get/enterprises/{enterprise}/announcement
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ 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.

Feinkörnige Zugriffstoken für "Set announcement banner for enterprise"

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

Parameter für "Set announcement banner for enterprise"

Header
accept string

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

Pfadparameter
enterprise string Erforderlich

The slug version of the enterprise name.

Körperparameter
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.

user_dismissible boolean or null

Whether an announcement can be dismissed by the user.

Standard: false

HTTP-Antwortstatuscodes für "Set announcement banner for enterprise"

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für "Set announcement banner for enterprise"

Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com.

Anforderungsbeispiel

patch/enterprises/{enterprise}/announcement
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ 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.

Feinkörnige Zugriffstoken für "Remove announcement banner from enterprise"

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

Parameter für "Remove announcement banner from enterprise"

Header
accept string

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

Pfadparameter
enterprise string Erforderlich

The slug version of the enterprise name.

HTTP-Antwortstatuscodes für "Remove announcement banner from enterprise"

StatuscodeBESCHREIBUNG
204

No Content

Codebeispiele für "Remove announcement banner from enterprise"

Wenn Sie bei GHE.com auf GitHub zugreifen, ersetzen Sie api.github.com durch die dedizierte Unterdomäne Ihres Unternehmens unter api.SUBDOMAIN.ghe.com.

Anforderungsbeispiel

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

Response

Status: 204