GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to retrieve job information using the API v4 endpoint. It is useful for automating workflows that require fetching job details from GitLab CI/CD pipelines, such as monitoring job status, retrieving job logs, or integrating job data into other systems.

Use Case Examples

  1. Fetch details of a specific GitLab CI job by its ID to monitor its status.
  2. Retrieve job information to trigger notifications based on job outcomes.
  3. Integrate GitLab job data into a dashboard for continuous integration monitoring.

Properties

Name Meaning
Skip Authentication Option to bypass authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method HTTP method used for the API request, defaulting to GET.
Parameter Schema Schema defining the parameters for the getApiV4Job operation, used internally.
Request Body Schema Schema defining the request body for the getApiV4Job operation, used internally.
Request Path The API endpoint path for the getApiV4Job operation, fixed to /api/v4/job.

Output

JSON

  • job - The JSON object containing the details of the GitLab job retrieved from the API.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access job information.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that the job ID or parameters used in the request are valid and exist in the GitLab project.
  • Common error messages may include authentication failures, 404 not found if the job does not exist, or 403 forbidden if permissions are insufficient. Resolving these involves verifying credentials, permissions, and request parameters.

Links

Discussion