Broadcast Messages API

Broadcast Messages API

在 GitLab 8.12 中引入.

广播消息 API 对广播消息进行操作 .

从 GitLab 12.8 开始，GET 请求不需要身份验证. 所有其他广播消息 API 终结点只能由管理员访问. 非 GET 请求者：

  • 来宾将导致 .
  • 普通用户将导致403 Forbidden .

列出所有广播消息.

请求示例：

  1. curl "https://gitlab.example.com/api/v4/broadcast_messages"

响应示例：

  1. [  {  "message":"Example broadcast message",  "starts_at":"2016-08-24T23:21:16.078Z",  "ends_at":"2016-08-26T23:21:16.080Z",  "color":"#E75E40",  "font":"#FFFFFF",  "id":1,  "active":  false,  "target_path":  "*/welcome",  "broadcast_type":  "banner",  "dismissable":  false  }  ]

    Parameters:

    请求示例：

    响应示例：

    1. {  "message":"Deploy in progress",  "starts_at":"2016-08-24T23:21:16.078Z",  "ends_at":"2016-08-26T23:21:16.080Z",  "color":"#cecece",  "font":"#FFFFFF",  "id":1,  "active":false,  "target_path":  "*/welcome",  "broadcast_type":  "banner",  "dismissable":  false  }

    创建一个新的广播消息.

    1. POST /broadcast_messages

    Parameters:

    请求示例：

    1. curl --data "message=Deploy in progress&color=#cecece" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/broadcast_messages"

    更新现有的广播消息.

    1. PUT /broadcast_messages/:id

    Parameters:

    请求示例：

    1. curl --request PUT --data "message=Update message&color=#000" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/broadcast_messages/1"

    响应示例：

    1. {  "message":"Update message",  "starts_at":"2016-08-26T00:41:35.060Z",  "ends_at":"2016-08-26T01:41:35.060Z",  "color":"#000",  "font":"#FFFFFF",  "id":1,  "active":  true,  "target_path":  "*/welcome",  "broadcast_type":  "notification",  "dismissable":  false  }

    删除广播消息.

    Parameters: