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
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.
HTTP response status codes for "Get the global announcement banner"
Status code | Description |
---|---|
200 | OK |
Code samples for "Get the global announcement banner"
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.
Parameters for "Set the global announcement banner"
Headers |
---|
Name, Type, Description |
accept stringSetting to |
Body parameters |
Name, Type, Description |
announcement string or nullRequiredThe announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "Basic writing and formatting syntax." |
expires_at string or nullThe time at which the announcement expires. This is a timestamp in ISO 8601 format: |
HTTP response status codes for "Set the global announcement banner"
Status code | Description |
---|---|
200 | OK |
Code samples for "Set the global announcement banner"
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.
HTTP response status codes for "Remove the global announcement banner"
Status code | Description |
---|---|
204 | No Content |
Code samples for "Remove the global announcement banner"
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