GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves a specific broadcast message from the GitLab API using the message's unique ID. It is useful for scenarios where you need to fetch detailed information about a particular broadcast message, such as for monitoring announcements or integrating GitLab broadcast messages into other workflows.

Use Case Examples

  1. Fetch details of a broadcast message by its ID to display in a dashboard.
  2. Retrieve a broadcast message to trigger notifications or further processing based on its content.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, default is GET.
Path Parameters Parameters included in the API request path, specifically the broadcast message ID to fetch.

Output

JSON

  • id - The unique identifier of the broadcast message.
  • message - The content of the broadcast message.
  • starts_at - The start time when the broadcast message becomes active.
  • ends_at - The end time when the broadcast message expires.
  • created_at - Timestamp when the broadcast message was created.
  • updated_at - Timestamp when the broadcast message was last updated.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the broadcast message ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the base URL is correct and accessible.
  • If authentication is enabled, confirm that the API key or token has sufficient permissions to access broadcast messages.
  • Common error messages include 404 Not Found if the broadcast message ID does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion