GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API, specifically supporting the operation to update Jenkins service settings for a GitLab project via a PUT request to the endpoint `/api/v4/projects/{id}/services/jenkins`. It is useful for automating the configuration of Jenkins integration within GitLab projects, enabling continuous integration and deployment workflows.

Use Case Examples

  1. Updating Jenkins service settings for a specific GitLab project by providing the project ID and the desired configuration in the request body.
  2. Automating Jenkins service configuration across multiple projects in GitLab through workflow automation.

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 for the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but supporting PUT for this operation.
Parameter Schema Defines the required path and body parameters for the PUT operation to update Jenkins service settings.
Request Body Schema Schema for the request body to update Jenkins service settings, required for the PUT operation.
Request Path The API endpoint path for the operation, set to /api/v4/projects/{id}/services/jenkins.
Path Parameters Collection of path parameters, specifically the project ID required to identify the GitLab project to update Jenkins service settings for.

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and the project exists in GitLab.
  • Verify that the API key credential has sufficient permissions to update Jenkins service settings on the project.
  • Check the request body schema to ensure all required fields for Jenkins service configuration are included and correctly formatted.
  • If authentication is skipped, the request may fail due to lack of authorization.

Links

Discussion