GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node performs a POST request to the GitLab API endpoint `/api/v4/jobs/request`. It allows users to send a job request to GitLab, which is useful for automating job management within GitLab CI/CD pipelines or other job-related workflows. For example, it can be used to trigger a job programmatically or manage job requests dynamically based on external events.

Use Case Examples

  1. Triggering a GitLab CI job from an external system.
  2. Automating job requests in GitLab based on custom conditions.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to POST. Options include GET, POST, PUT, DELETE, HEAD, PATCH.
Parameter Schema Defines the schema for the request body parameters, required for the POST request to `/api/v4/jobs/request`.
Request Body Schema Schema for the request body, can be null if not specified.
Request Path The API endpoint path for the job request, fixed to `/api/v4/jobs/request`.

Output

JSON

  • response - The JSON response returned from the GitLab API after making the job request.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the GitLab API authentication credentials are correctly configured if authentication is not skipped.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that the request body matches the expected schema for the `/api/v4/jobs/request` endpoint to avoid validation errors.
  • Common errors include authentication failures, invalid request body format, or network connectivity issues.

Links

Discussion