GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves a specific broadcast message from the GitLab API using its ID. It is useful for scenarios where you need to fetch detailed information about a particular broadcast message in a GitLab instance, such as for monitoring announcements or system messages.

Use Case Examples

  1. Fetch a broadcast message by its ID to display its content in a dashboard.
  2. Retrieve broadcast message details for auditing or logging purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process 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 request is sent.
Method The HTTP method used for the API request, default is GET.
Path Parameters Parameters to be included in the 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.
  • color - The color associated with the broadcast message for UI display.
  • broadcast_type - The type/category of the broadcast message.

Dependencies

  • GitLab 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 baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • If skipping authentication, confirm that the API endpoint allows unauthenticated access, otherwise authentication errors will occur.
  • Check network connectivity and API rate limits if requests fail or time out.

Links

Discussion