GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API, specifically supporting the operation to get job details via the GitLab API v4 endpoint. It is useful for automating workflows that require fetching job information from GitLab CI/CD pipelines, such as monitoring job status or retrieving job metadata for further processing.

Use Case Examples

  1. Fetch details of a specific GitLab CI job to monitor its status in an automated deployment pipeline.
  2. Retrieve job information to trigger notifications or logging based on job outcomes.

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 requests are sent.
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 path for the getApiV4Job operation, fixed to /api/v4/job.

Output

JSON

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

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the baseUrl is correctly set to the GitLab instance URL; incorrect URLs will cause request failures.
  • If authentication is not skipped, verify that the GitLab API key credential is valid and has sufficient permissions to access job details.
  • Common errors include 401 Unauthorized (invalid or missing API key) and 404 Not Found (job ID or path incorrect).
  • Check network connectivity to the GitLab instance if requests time out or fail.

Links

Discussion