GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation fetches broadcast messages from the GitLab API (version 4). It is useful for retrieving system-wide announcements or messages broadcasted to all users in a GitLab instance. Typical use cases include monitoring GitLab status updates, maintenance notifications, or other important communications from GitLab administrators.

Use Case Examples

  1. Retrieve the first page of broadcast messages with default pagination.
  2. Customize the number of messages per page to control the volume of data returned.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method HTTP method used for the API request, default is GET.
Query Parameters Parameters to control pagination of the broadcast messages.

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.
  • color - Color code associated with the message.
  • broadcast_type - Type/category of the broadcast message.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access broadcast messages.
  • Verify the baseUrl is correct and points to a valid GitLab instance.
  • Check pagination parameters (page and per_page) to avoid requesting out-of-range pages which may result in empty responses.

Links

Discussion