GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API, specifically supporting the operation to update the Campfire service settings for a project via a PUT request to the endpoint `/api/v4/projects/{id}/services/campfire`. It is useful for automating the configuration of project services in GitLab, such as enabling or modifying Campfire integration settings programmatically.

Use Case Examples

  1. Updating Campfire service settings for a specific GitLab project by providing the project ID and the desired configuration in the request body.
  2. Automating service configuration changes across multiple projects in GitLab using this node in an n8n workflow.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, default is false (authentication required).
Authentication Type of authentication used, default is GitLab API key authentication. Hidden if Skip Authentication is true.
baseUrl Base URL for the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET. For this operation, it is PUT.
Parameter Schema Schema defining the required path parameter 'id' (project ID) and the request body schema for the Campfire service update. Hidden property.
Request Body Schema Schema for the request body to update Campfire service settings. Hidden property.
Request Path API endpoint path for the operation, default is /api/v4/projects/{id}/services/campfire. Hidden property.
Path Parameters Collection of path parameters, specifically the 'id' parameter representing the project ID to update the Campfire service for.

Output

JSON

  • response - The JSON response from the GitLab API after updating the Campfire service settings for the specified project.

Dependencies

  • Requires GitLab API key credential for authentication unless Skip Authentication is enabled.

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and the project exists in GitLab.
  • Verify that the API key used has sufficient permissions to update project services.
  • If authentication is skipped, the request may fail due to lack of authorization.
  • Check the request body schema to ensure all required fields for the Campfire service update are correctly provided.
  • Common error messages include 401 Unauthorized (authentication issues), 404 Not Found (invalid project ID), and 400 Bad Request (invalid request body).

Links

Discussion