GitLab API

GitlabTool
Join our community

Actions1000

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 broadcast messages displayed in GitLab, such as announcements or alerts. For example, an administrator might use this node to programmatically access and display current broadcast messages in a dashboard or to monitor system notifications.

Use Case Examples

  1. Fetch the first page of broadcast messages with default pagination.
  2. Customize the number of messages per page by setting the 'per_page' query parameter.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process for the API request.
Authentication Specifies the authentication method to use, hidden if skipping authentication is enabled.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method HTTP method used for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Query Parameters Collection of query parameters to customize the API request, including pagination options 'page' and 'per_page'.

Output

JSON

  • id - Unique identifier of the broadcast message.
  • message - Content of the broadcast message.
  • starts_at - Start date and time when the broadcast message becomes active.
  • ends_at - End date and time when the broadcast message expires.
  • color - Color code associated with the broadcast message.
  • broadcast_type - Type/category of the broadcast message.
  • active - Boolean indicating if the broadcast message is currently active.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the baseUrl is correctly set to the GitLab instance URL to avoid connection errors.
  • If authentication is required and skipped, the API request may fail with authorization errors.
  • Verify that the query parameters 'page' and 'per_page' are valid integers to prevent request errors.
  • Common error messages include 401 Unauthorized (check API credentials) and 404 Not Found (verify the API path and resource availability).

Links

Discussion