GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates a broadcast message in GitLab by sending a PUT request to the GitLab API endpoint `/api/v4/broadcast_messages/{id}`. It is useful for modifying existing broadcast messages, such as changing their content or settings, by specifying the message ID and providing the updated data in the request body.

Use Case Examples

  1. Updating the content of a broadcast message to notify users about scheduled maintenance.
  2. Changing the expiration date of a broadcast message to extend its visibility.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process 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 request, defaulting to PUT for this operation.
Path Parameters Parameters included in the URL path, specifically the ID of the broadcast message to update.

Output

JSON

  • id - The unique identifier of the updated broadcast message.
  • message - The content or text 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 or is no longer active.
  • color - The color code associated with the broadcast message for display purposes.
  • broadcast_type - The type or category of the broadcast message.

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 authentication credentials are correctly configured and have sufficient permissions to update broadcast messages.
  • Check that the request body schema matches the expected format for updating broadcast messages to avoid validation errors.

Discussion