GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation deletes a broadcast message in GitLab by its ID. It is useful for automating the removal of outdated or irrelevant broadcast messages from a GitLab instance. For example, a user can set up a workflow to delete specific broadcast messages based on certain conditions 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 cleanup of broadcast messages after a certain event or time period.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication to use, default is 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 - ID of the deleted broadcast message
  • status - Status of the delete operation, e.g., success or failure
  • message - Additional message or information about the delete operation

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the broadcast message ID provided in the path parameters is valid and exists in the GitLab instance.
  • If authentication is enabled, verify that the GitLab API key credential is correctly configured and has sufficient permissions to delete broadcast messages.
  • Check the baseUrl property to ensure it points to the correct GitLab instance URL.
  • Common error messages include 404 Not Found if the broadcast message ID does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion