GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves detailed information about a specific job within a project on GitLab using the GitLab API v4. It is useful for scenarios where users need to monitor or manage CI/CD jobs associated with their GitLab projects, such as checking job status, logs, or results.

Use Case Examples

  1. A DevOps engineer wants to fetch the status and details of a particular CI job in a project to automate deployment decisions.
  2. A project manager needs to retrieve job information to track build progress and report on pipeline health.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request, useful for public or unauthenticated endpoints.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Parameters to specify the project ID and job ID for the API request.

Output

JSON

  • id - The unique identifier of the job.
  • status - Current status of the job (e.g., success, failed, running).
  • stage - The stage of the pipeline the job belongs to.
  • name - Name of the job.
  • ref - Git reference (branch or tag) the job is associated with.
  • created_at - Timestamp when the job was created.
  • started_at - Timestamp when the job started.
  • finished_at - Timestamp when the job finished.
  • duration - Duration of the job execution in seconds.
  • user - Information about the user who triggered the job.
  • pipeline - Details about the pipeline the job is part of.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and job ID are correct and exist in the GitLab instance to avoid 404 errors.
  • If authentication is required, verify that the API key credential is valid and has sufficient permissions to access job details.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure the URL is correct and accessible.

Links

Discussion