GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates a broadcast message in GitLab using the PUT method on the endpoint /api/v4/broadcast_messages/{id}. It is useful for modifying existing broadcast messages by specifying the message ID and providing the updated message data in the request body. Practical applications include automating updates to announcements or notifications broadcasted within a GitLab instance.

Use Case Examples

  1. Updating the content or timing of a GitLab broadcast message by specifying its ID and new details.
  2. Automating the management of broadcast messages in GitLab projects or groups.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET but for this operation it is PUT.
Path Parameters Parameters to be included in the request path, specifically the broadcast message ID to update.

Output

JSON

  • id - The unique identifier of the broadcast message.
  • message - The content of the broadcast message.
  • starts_at - The start time of the broadcast message.
  • ends_at - The end time of the broadcast message.
  • color - The color associated with the broadcast message.
  • font - The font style used in the broadcast message.
  • 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 authentication credentials (GitLab API key) are correctly configured and have sufficient permissions to update broadcast messages.
  • Check that the request body schema matches the expected structure for updating broadcast messages to avoid validation errors.

Links

Discussion