GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves jobs for a specific project from the GitLab API (v4). It is useful for users who want to monitor or manage CI/CD jobs associated with a GitLab project. For example, a DevOps engineer might use this node to fetch the status of all jobs in a project to automate deployment pipelines or generate reports.

Use Case Examples

  1. Fetch all jobs for a project with ID '12345' to check their statuses.
  2. Retrieve only running and pending jobs for a project to monitor active CI/CD processes.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip authentication when making the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to connect to, default is https://gitlab.com.
Method The HTTP method used for the API request, default is GET.
Query Parameters Optional query parameters to filter and paginate the jobs list.
Path Parameters Path parameters required for the API endpoint.

Output

JSON

  • jobs - An array of job objects returned from the GitLab API, each representing a CI/CD job associated with the specified project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • If authentication is skipped, the API request may fail due to lack of permissions.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.
  • Pagination parameters (page and per_page) should be valid integers; otherwise, the API may return errors or unexpected results.

Links

Discussion