GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to manage Jira Connect subscriptions via the specified API endpoint. It is designed to send HTTP requests, particularly a POST request to the /api/v4/integrations/jira_connect/subscriptions path, allowing users to create or manage Jira Connect subscriptions within GitLab. This node is useful for automating integration setups between GitLab and Jira, streamlining project management workflows.

Use Case Examples

  1. Creating a new Jira Connect subscription in GitLab by sending the required subscription details in the request body.
  2. Automating the management of Jira Connect subscriptions as part of a CI/CD pipeline or project setup process.

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, with options including GET, POST, PUT, DELETE, HEAD, and PATCH.
Parameter Schema Defines the schema for the parameters sent in the request body for the postApiV4IntegrationsJiraConnectSubscriptions operation.
Request Body Schema Defines the schema for the request body content for the postApiV4IntegrationsJiraConnectSubscriptions operation.
Request Path The API endpoint path for the Jira Connect subscriptions operation, fixed to /api/v4/integrations/jira_connect/subscriptions.

Output

JSON

  • response - The JSON response returned from the GitLab API after creating or managing a Jira Connect subscription.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has the necessary permissions to manage Jira Connect subscriptions.
  • Verify the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.
  • Check that the request body matches the expected schema for the Jira Connect subscription to avoid validation errors from the API.

Links

Discussion