Points de terminaison de l’API REST pour les annonces globales
Utilisez l’API REST pour gérer la bannière d’annonce globale dans votre entreprise.
À propos des annonces
Vous pouvez utiliser l’API REST pour gérer la bannière d’annonce globale dans votre entreprise. Pour plus d’informations, consultez « Personnalisation des messages utilisateur pour votre entreprise ».
Ces points de terminaison prennent uniquement en charge l’authentification à l’aide d’un personal access token (classic). Pour plus d’informations, consultez « Gestion de vos jetons d'accès personnels ».
Get the global announcement banner
Gets the current message and expiration date of the global announcement banner in your enterprise.
Jetons d’accès affinés pour « Get the global announcement banner »
Ce point de terminaison ne fonctionne pas avec les jetons d’accès utilisateur d’application GitHub, les jetons d’accès d’installation d’application GitHub ou les jetons d’accès personnels affinés.
Codes d’état de la réponse HTTP pour « Get the global announcement banner »
| Code d’état | Description |
|---|---|
200 | OK |
Exemples de code pour « Get the global announcement banner »
Exemple de requête
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/announcementAnnouncement 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.
Jetons d’accès affinés pour « Set the global announcement banner »
Ce point de terminaison ne fonctionne pas avec les jetons d’accès utilisateur d’application GitHub, les jetons d’accès d’installation d’application GitHub ou les jetons d’accès personnels affinés.
Paramètres pour « Set the global announcement banner »
| Nom, Type, Description |
|---|
accept string Setting to |
| Nom, Type, Description |
|---|
announcement string or null ObligatoireThe 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: |
Codes d’état de la réponse HTTP pour « Set the global announcement banner »
| Code d’état | Description |
|---|---|
200 | OK |
Exemples de code pour « Set the global announcement banner »
Exemple de requête
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.
Jetons d’accès affinés pour « Remove the global announcement banner »
Ce point de terminaison ne fonctionne pas avec les jetons d’accès utilisateur d’application GitHub, les jetons d’accès d’installation d’application GitHub ou les jetons d’accès personnels affinés.
Codes d’état de la réponse HTTP pour « Remove the global announcement banner »
| Code d’état | Description |
|---|---|
204 | No Content |
Exemples de code pour « Remove the global announcement banner »
Exemple de requête
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/announcementResponse
Status: 204