GitLab API icon

GitLab API

Gitlab

Actions917

Overview

This node interacts with the GitLab API to update the Pivotal Tracker integration settings for a specific project. It is useful for automating the configuration of project integrations within GitLab, particularly for teams using Pivotal Tracker for issue tracking and project management. For example, it can be used to programmatically enable or modify the Pivotal Tracker integration on a GitLab project as part of a CI/CD pipeline or project setup automation.

Use Case Examples

  1. Updating Pivotal Tracker integration settings for a GitLab project by specifying the project ID and providing the integration configuration in the request body.
  2. Automating the management of project integrations in GitLab to ensure consistent setup across multiple projects.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL for the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method used for the API request, defaulting to GET but supporting PUT for this operation.
Parameter Schema Schema defining the path and body parameters for the operation, including the project ID and the Pivotal Tracker integration settings.
Request Body Schema Schema defining the structure of the request body for the operation, representing the Pivotal Tracker integration configuration.
Request Path API endpoint path for updating the Pivotal Tracker integration on a project, 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 Pivotal Tracker integration.

Dependencies

  • GitLab API key credential

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 project integrations.
  • Check the request body schema to ensure it matches the expected structure for the Pivotal Tracker integration settings.
  • If authentication is skipped, the API request may fail due to lack of authorization.

Links

Discussion