Después de que un administrador del sitio actualice la instancia de Enterprise Server a Enterprise Server 3.9 o posterior, la API de REST tendrá control de versiones. Para informarte sobre cómo encontrar la versión de tu instancia, consulta "Acerca de las versiones de GitHub Docs". Para obtener más información, consulta "Acerca del control de versiones de la API".

Anuncio

La API de REST permite administrar el banner de anuncios globales de una empresa.

Acerca de los anuncios

La API de REST permite administrar el banner de anuncio global de una empresa. Para obtener más información, vea «Personalizar los mensajes de usuario para tu empresa».

Get the global announcement banner

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

Códigos de estado de respuesta HTTP para "Get the global announcement banner"

status codeDescripción
200

OK

Ejemplos de código para "Get the global announcement banner"

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.

Parámetros para "Set the global announcement banner"

Encabezados
accept string

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

Parámetros del cuerpo
announcement string or null Requerido

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.

Códigos de estado de respuesta HTTP para "Set the global announcement banner"

status codeDescripción
200

OK

Ejemplos de código para "Set the global announcement banner"

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.

Códigos de estado de respuesta HTTP para "Remove the global announcement banner"

status codeDescripción
204

No Content

Ejemplos de código para "Remove the global announcement banner"

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