Esta versão do GitHub Enterprise Server foi descontinuada em 2024-07-09. 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.

O controle de versão da API REST já foi feito. Para obter mais informações, confira "Sobre o controle de versão da API".

Pontos de extremidade da API REST para anúncios globais

Use a API REST para gerenciar a faixa de comunicados globais em sua empresa.

Sobre comunicados

Você pode usar a API REST para gerenciar a faixa de comunicados globais em sua empresa. Para obter mais informações, confira "Personalizar mensagens de usuário para sua empresa".

Get the global announcement banner

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

Códigos de status de resposta HTTP para "Get the global announcement banner"

Código de statusDescrição
200

OK

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

Exemplo de solicitação

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.

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.

Códigos de status de resposta HTTP para "Set the global announcement banner"

Código de statusDescrição
200

OK

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

Exemplo de solicitação

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.

Códigos de status de resposta HTTP para "Remove the global announcement banner"

Código de statusDescrição
204

No Content

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

Exemplo de solicitação

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