GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates the Campfire integration settings for a specific GitLab project using the GitLab API. It is useful for automating the configuration of project integrations, particularly for teams using Campfire for chat and notifications within their GitLab projects. For example, a user can update the Campfire integration to change notification settings or authentication details programmatically.

Use Case Examples

  1. Updating Campfire integration settings for a GitLab project to enable or disable notifications.
  2. Automating the configuration of multiple projects' Campfire integrations in a CI/CD pipeline.

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 PUT for this operation.
Path Parameters Parameters included in the API request path, specifically the project ID for this operation.

Output

JSON

  • id - The ID of the GitLab project.
  • integration - The updated Campfire integration details for the project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to update project integrations.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 401 Unauthorized (authentication failure), 404 Not Found (invalid project ID or integration endpoint), and 400 Bad Request (invalid request body). Resolving these involves verifying credentials, project ID, and request payload format.

Links

Discussion