Конечные точки REST API для баннеров объявлений предприятия
API объявлений enterprise позволяет получить, задать и удалить баннер объявления для вашего предприятия.
Get announcement banner for enterprise
Gets the announcement banner currently set for the enterprise.
Подробные маркеры доступа для "Get announcement banner for enterprise
Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.
Параметры для "Get announcement banner for enterprise"
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Коды состояния http-ответа для "Get announcement banner for enterprise"
| Код состояния | Описание |
|---|---|
200 | OK |
Примеры кода для "Get announcement banner for enterprise"
Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.
Пример запроса
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/announcementAnnouncement banner
Status: 200{
"announcement": "Very **important** announcement about _something_.",
"expires_at": "2021-01-01T00:00:00.000+00:00",
"user_dismissible": false
}Set announcement banner for enterprise
Sets the announcement banner to display for the enterprise.
Подробные маркеры доступа для "Set announcement banner for enterprise
Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.
Параметры для "Set announcement banner for enterprise"
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
| Имя., Тип, Description |
|---|
announcement string or null Обязательное поле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: |
user_dismissible boolean or null Whether an announcement can be dismissed by the user. По умолчанию.: |
Коды состояния http-ответа для "Set announcement banner for enterprise"
| Код состояния | Описание |
|---|---|
200 | OK |
Примеры кода для "Set announcement banner for enterprise"
Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.
Пример запроса
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/announcement \
-d '{"announcement":"Very **important** announcement about _something_.","expires_at":"2021-01-01T00:00:00.000+00:00","user_dismissible":false}'Announcement banner
Status: 200{
"announcement": "Very **important** announcement about _something_.",
"expires_at": "2021-01-01T00:00:00.000+00:00",
"user_dismissible": false
}Remove announcement banner from enterprise
Removes the announcement banner currently set for the enterprise.
Подробные маркеры доступа для "Remove announcement banner from enterprise
Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.
Параметры для "Remove announcement banner from enterprise"
| Имя., Тип, Description |
|---|
accept string Setting to |
| Имя., Тип, Description |
|---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Коды состояния http-ответа для "Remove announcement banner from enterprise"
| Код состояния | Описание |
|---|---|
204 | No Content |
Примеры кода для "Remove announcement banner from enterprise"
Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.
Пример запроса
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/enterprises/ENTERPRISE/announcementResponse
Status: 204