GitLab API

GitlabTool
Join our community

Actions1000

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 Option to skip authentication when making the API request.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method HTTP method used for the API request, default is GET.
Path Parameters Parameters to be 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 credentials

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 correctly set to the GitLab instance you intend to query.
  • If authentication is required, confirm that the GitLab API credentials are correctly configured and have sufficient permissions to access broadcast messages.
  • Common error messages may include 404 Not Found if the broadcast message ID does not exist, or 401 Unauthorized if authentication fails.

Links

Discussion