GitLab

GitLab Broadcast Messages API

The Broadcast Messages API from GitLab — 2 operation(s) for broadcast messages.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v4/broadcast_messages/{id} Get a broadcast message · GitLab Get a Specific Broadcast Message #
Ask an LLM
“How do I view one broadcast banner and its schedule?”
“What audience and dates are set on a specific broadcast message?”
Tell an agent
Show broadcast message {id}.
Get the text and schedule of broadcast {id}.
PUT /api/v4/broadcast_messages/{id} Update a broadcast message · GitLab Update a Broadcast Message #
Ask an LLM
“How do I change the wording or end date of an existing announcement banner?”
“Can I retarget an existing broadcast to certain access levels or paths?”
Tell an agent
Change the text of broadcast message {id} to {message}.
Extend broadcast {id} so it ends at {ends_at}.
DELETE /api/v4/broadcast_messages/{id} Delete a broadcast message · GitLab Delete a Broadcast Message #
Ask an LLM
“How do I take down an announcement banner from my GitLab instance?”
“Can I permanently delete a broadcast message?”
Tell an agent destructive · confirm first
Delete broadcast message {id}.
Remove the announcement banner {id}.
GET /api/v4/broadcast_messages List all broadcast messages · GitLab Get All Broadcast Messages #
Ask an LLM
“What announcement banners are configured on the instance?”
“Where can I see every past and scheduled broadcast message?”
Tell an agent
List all broadcast messages.
Show page {page} of the broadcast messages.
POST /api/v4/broadcast_messages Create a broadcast message · GitLab Create a Broadcast Message #
Ask an LLM
“How do I post a maintenance banner to all users of my GitLab instance?”
“Can I schedule a broadcast to start and end at set times?”
Tell an agent
Create a broadcast message saying {message}.
Broadcast {message} from {starts_at} until {ends_at}.

Documentation

📖
Documentation
https://docs.gitlab.com/api/groups/
📖
Authentication
https://docs.gitlab.com/api/rest/authentication/
📖
Documentation
https://docs.gitlab.com/api/projects/
📖
Documentation
https://docs.gitlab.com/api/admin/
📖
Documentation
https://docs.gitlab.com/api/applications/
📖
Documentation
https://docs.gitlab.com/api/avatar/
📖
Documentation
https://docs.gitlab.com/api/broadcast_messages/
📖
Documentation
https://docs.gitlab.com/api/bulk_imports/
📖
Documentation
https://docs.gitlab.com/api/settings/
📖
Documentation
https://docs.gitlab.com/api/metadata/
📖
Documentation
https://docs.gitlab.com/api/version/
📖
Documentation
https://docs.gitlab.com/api/rest/
📖
APIReference
https://docs.gitlab.com/api/api_resources/
📖
RateLimits
https://docs.gitlab.com/security/rate_limits/
📖
Documentation
https://docs.gitlab.com/api/oauth2/
📖
Authentication
https://docs.gitlab.com/integration/oauth_provider/
📖
Documentation
https://docs.gitlab.com/user/project/integrations/webhooks.html
📖
APIReference
https://docs.gitlab.com/api/project_webhooks/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gitlab/refs/heads/main/openapi/gitlab-broadcast-messages-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/gitlab/refs/heads/main/asyncapi/gitlab-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitlab/refs/heads/main/json-schema/gitlab-api-entities-broadcast-message-schema.json

Other Resources

🔗
SDKs
https://docs.gitlab.com/api/rest/third_party_clients/
🔗
Interactive Documentation
https://docs.gitlab.com/api/openapi/openapi_interactive/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gitlab:gitlab-broadcast-messages-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gitlab-broadcast-messages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitLab Broadcast Messages API
  version: v4
  description: An OpenAPI definition for the GitLab REST API.
  termsOfService: https://about.gitlab.com/terms/
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
servers:
- url: https://www.gitlab.com/api/
security:
- ApiKeyAuth: []
tags:
- name: Broadcast Messages
  description: Operations about broadcast_messages
paths:
  /api/v4/broadcast_messages/{id}:
    get:
      tags:
      - Broadcast Messages
      summary: GitLab Get a Specific Broadcast Message
      description: This feature was introduced in GitLab 8.12.
      operationId: getApiV4BroadcastMessagesId
      parameters:
      - name: id
        in: path
        description: Broadcast message ID
        required: true
        schema:
          type: integer
          format: int32
        example: 42
      responses:
        '200':
          description: Get a specific broadcast message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_BroadcastMessage'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      tags:
      - Broadcast Messages
      summary: GitLab Update a Broadcast Message
      description: This feature was introduced in GitLab 8.12.
      operationId: putApiV4BroadcastMessagesId
      parameters:
      - name: id
        in: path
        description: Broadcast message ID
        required: true
        schema:
          type: integer
          format: int32
        example: 42
      requestBody:
        content:
          application/json:
            schema:
              properties:
                message:
                  type: string
                  description: Message to display
                starts_at:
                  type: string
                  description: Starting time
                  format: date-time
                ends_at:
                  type: string
                  description: Ending time
                  format: date-time
                color:
                  type: string
                  description: Background color
                font:
                  type: string
                  description: Foreground color
                target_access_levels:
                  type: array
                  description: Target user roles
                  items:
                    type: integer
                    format: int32
                    enum:
                    - 10
                    - 20
                    - 30
                    - 40
                    - 50
                target_path:
                  type: string
                  description: Target path
                broadcast_type:
                  type: string
                  description: Broadcast Type
                  enum:
                  - banner
                  - notification
                dismissable:
                  type: boolean
                  description: Is dismissable
      responses:
        '200':
          description: Update a broadcast message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_BroadcastMessage'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Broadcast Messages
      summary: GitLab Delete a Broadcast Message
      description: This feature was introduced in GitLab 8.12.
      operationId: deleteApiV4BroadcastMessagesId
      parameters:
      - name: id
        in: path
        description: Broadcast message ID
        required: true
        schema:
          type: integer
          format: int32
        example: 42
      responses:
        '200':
          description: Delete a broadcast message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_BroadcastMessage'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v4/broadcast_messages:
    get:
      tags:
      - Broadcast Messages
      summary: GitLab Get All Broadcast Messages
      description: This feature was introduced in GitLab 8.12.
      operationId: getApiV4BroadcastMessages
      parameters:
      - name: page
        in: query
        description: Current page number
        schema:
          type: integer
          format: int32
          default: 1
        example: 42
      - name: per_page
        in: query
        description: Number of items per page
        schema:
          type: integer
          format: int32
          default: 20
        example: 42
      responses:
        '200':
          description: Get all broadcast messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_BroadcastMessage'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - Broadcast Messages
      summary: GitLab Create a Broadcast Message
      description: This feature was introduced in GitLab 8.12.
      operationId: postApiV4BroadcastMessages
      requestBody:
        content:
          application/json:
            schema:
              required:
              - message
              properties:
                message:
                  type: string
                  description: Message to display
                starts_at:
                  type: string
                  description: Starting time
                  format: date-time
                ends_at:
                  type: string
                  description: Ending time
                  format: date-time
                color:
                  type: string
                  description: Background color
                font:
                  type: string
                  description: Foreground color
                target_access_levels:
                  type: array
                  description: Target user roles
                  items:
                    type: integer
                    format: int32
                    enum:
                    - 10
                    - 20
                    - 30
                    - 40
                    - 50
                target_path:
                  type: string
                  description: Target path
                broadcast_type:
                  type: string
                  description: Broadcast type. Defaults to banner
                  enum:
                  - banner
                  - notification
                dismissable:
                  type: boolean
                  description: Is dismissable
        required: true
      responses:
        '201':
          description: Create a broadcast message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_BroadcastMessage'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    API_Entities_BroadcastMessage:
      type: object
      properties:
        id:
          type: string
          example: '123456'
        message:
          type: string
          example: example_value
        starts_at:
          type: string
          example: '2026-04-17T12:00:00Z'
        ends_at:
          type: string
          example: '2026-04-17T12:00:00Z'
        color:
          type: string
          example: example_value
        font:
          type: string
          example: example_value
        target_access_levels:
          type: string
          example: example_value
        target_path:
          type: string
          example: my-group/my-project
        broadcast_type:
          type: string
          example: example_value
        dismissable:
          type: string
          example: example_value
        active:
          type: string
          example: example_value
      description: API_Entities_BroadcastMessage model
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Private-Token