GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to post broadcast messages using the /api/v4/broadcast_messages endpoint. It is useful for automating the creation and management of broadcast messages in GitLab, such as announcements or alerts to all users in a GitLab instance.

Use Case Examples

  1. Automatically post a broadcast message to notify all users about scheduled maintenance.
  2. Create a broadcast message to announce new features or updates in a GitLab project.

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 request is sent.
Method The HTTP method used for the API request, defaulting to POST for this operation.
Parameter Schema Defines the schema for the parameters sent in the request body for posting broadcast messages.
Request Body Schema Defines the schema for the request body content for posting broadcast messages.
Request Path The API endpoint path for posting broadcast messages, fixed to /api/v4/broadcast_messages.

Output

JSON

  • response - The JSON response from the GitLab API after posting the broadcast message, typically containing details of the created broadcast message.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the baseUrl is correctly set to the GitLab instance URL to avoid connection errors.
  • If authentication is skipped, the API request may fail due to lack of permissions.
  • Verify that the request body matches the expected schema for posting broadcast messages to avoid validation errors from the API.

Links

Discussion