Skip to main content

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.

Anúncio

A API de Anúncio permite que você gerencie o banner de anúncio global na sua empresa.

Anúncio

A API de anúncios permite que você gerencie o banner de anúncio global na sua empresa. Para obter mais informações, consulte "Personalizar mensagens de usuários para a sua empresa".

Get the global announcement banner

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

HTTP response status codes

Status codeDescrição
200

OK

Amostras de código

get/enterprise/announcement
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/enterprise/announcement

Default response

Status: 200
{ "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" }

Set the global announcement banner

Sets the message and expiration time for the global announcement banner in your enterprise.

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

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

Body parameters
Nome, Tipo, Descrição
announcementstringObrigatório

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax."

expires_atstring 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 response status codes

Status codeDescrição
200

OK

Amostras de código

patch/enterprise/announcement
curl \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/enterprise/announcement

Default response

Status: 200
{ "announcement": "Very **important** announcement about _nothing_.", "expires_at": "2021-01-01T00:00:00.000+00:00" }

Remove the global announcement banner

Removes the global announcement banner in your enterprise.

HTTP response status codes

Status codeDescrição
204

No Content

Amostras de código

delete/enterprise/announcement
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/enterprise/announcement

Response

Status: 204