GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation deletes a broadcast message in GitLab by its ID. It is useful for managing and removing outdated or irrelevant broadcast messages from a GitLab instance. For example, an administrator can automate the deletion of specific broadcast messages based on certain criteria or schedules.

Use Case Examples

  1. Deleting a broadcast message by specifying its ID to keep the GitLab instance clean and up-to-date.
  2. Automating the removal of expired announcements or notifications from GitLab broadcast messages.

Properties

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

Output

JSON

  • id - The ID of the deleted broadcast message
  • message - Confirmation or status message of the deletion operation

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the broadcast message ID is valid and exists; otherwise, the deletion will fail.
  • Check that the API key has sufficient permissions to delete broadcast messages.
  • Verify the base URL is correct and accessible.
  • Common error messages include 404 Not Found if the message ID does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion