GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API, specifically supporting the operation to update the Jira Cloud App service configuration for a GitLab project via a PUT request to the endpoint `/api/v4/projects/{id}/services/jira-cloud-app`. It is useful for automating the management of Jira Cloud integration settings within GitLab projects, such as updating service parameters programmatically.

Use Case Examples

  1. Automatically update Jira Cloud App settings for a GitLab project when project details change.
  2. Integrate GitLab project service configuration updates into 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 for the API request, 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 API request, defaulting to GET but supporting PUT for this operation.
Parameter Schema Defines the parameters required for the operation, including the project ID in the path and the request body schema for the Jira Cloud App service update.
Request Body Schema The schema defining the structure of the request body for the Jira Cloud App service update.
Request Path The API endpoint path for the operation, with a placeholder for the project ID.
Path Parameters Collection of path parameters required for the API request, specifically the project ID.

Output

JSON

  • response - The JSON response from the GitLab API after updating the Jira Cloud App service configuration.

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 credential has sufficient permissions to update project services.
  • Check that the request body conforms to the expected schema for the Jira Cloud App service update to avoid validation errors.

Links

Discussion