GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves broadcast messages from the GitLab API (version 4). It is useful for scenarios where users want to fetch system-wide announcements or notifications broadcasted by GitLab administrators. For example, an organization might use this to display important GitLab messages within their internal tools or dashboards.

Use Case Examples

  1. Fetch the first page of broadcast messages with a default of 20 messages per page.
  2. Customize the number of messages per page and navigate through pages using the 'page' and 'per_page' query parameters.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request. If true, the request is made without authentication.
Authentication Specifies the authentication method to use for the API request, defaulting to GitLab API key authentication. This property is hidden if 'Skip Authentication' is true.
baseUrl The base URL of the GitLab instance to which the API request is sent. Defaults to 'https://gitlab.com'.
Method The HTTP method used for the API request. Defaults to GET, but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Query Parameters Optional query parameters to customize the API request, including pagination options such as 'page' (current page number) and 'per_page' (number of items per page).

Output

JSON

  • id - Unique identifier of the broadcast message
  • message - Content of the broadcast message
  • starts_at - Start time of the broadcast message
  • ends_at - End time of the broadcast message
  • created_at - Timestamp when the message was created
  • updated_at - Timestamp when the message was last updated
  • broadcast_type - Type/category of the broadcast message
  • color - Color associated with the broadcast message for UI display
  • active - Boolean indicating if the broadcast message is currently active

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has the necessary permissions to access broadcast messages.
  • Verify the base URL is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that the query parameters 'page' and 'per_page' are valid integers and within acceptable ranges to avoid API errors.
  • If skipping authentication, confirm that the GitLab instance allows unauthenticated access to broadcast messages, otherwise the request will fail.

Links

Discussion