Esta versão do GitHub Enterprise Server será descontinuada em 2026-06-02. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

A API REST agora é versionada. Para obter mais informações, confira "Sobre o controle de versão da API".

Endpoints da API REST para anúncios globais

Use a API REST para gerenciar o banner de anúncios globais na sua empresa.

Sobre comunicados

Você pode usar a API REST para gerenciar o banner de anúncios globais no seu empreendimento. Para saber mais, confira Personalizar mensagens de usuário para sua empresa.

Observação

Esses pontos de extremidade só dão suporte à autenticação por meio de um personal access token (classic). Para saber mais, confira Gerenciar seus tokens de acesso pessoal.

Get the global announcement banner

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

fine_grained_access

no_fine_grained_access

http_status_code

status_codeDescrição
200

OK

code_samples

request_example

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.

fine_grained_access

no_fine_grained_access

Parâmetros para "Set the global announcement banner"

Cabeçalhos
accept string

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

Parâmetros do corpo
announcement string or null Obrigatório

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.

Padrão: false

http_status_code

status_codeDescrição
200

OK

code_samples

request_example

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.

fine_grained_access

no_fine_grained_access

http_status_code

status_codeDescrição
204

No Content

code_samples

request_example

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