GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves upcoming jobs for a specific resource group within a GitLab project using the GitLab API. It is useful for monitoring and managing CI/CD pipeline jobs that are scheduled to run soon in a particular resource group of a project. For example, a DevOps engineer can use this node to fetch and display upcoming jobs to optimize resource allocation and pipeline scheduling.

Use Case Examples

  1. Fetch upcoming CI jobs for a resource group in a project to monitor pipeline status.
  2. Retrieve paginated lists of upcoming jobs to analyze job queue and resource usage.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines required and optional parameters for the API call, including project ID, resource group key, page number, and items per page.
Request Body Schema Schema for the request body, null for this GET operation.
Request Path API endpoint path with placeholders for project ID and resource group key.
Query Parameters Optional query parameters for pagination: page number and items per page.
Path Parameters Path parameters specifying the project ID and resource group key.

Output

JSON

  • jobs - List of upcoming jobs in the specified resource group of the project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and resource group key are correctly specified and URL-encoded if necessary.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access the project and resource group.
  • Check network connectivity to the specified GitLab base URL.
  • If pagination parameters are used, ensure they are valid integers to avoid request errors.

Links

Discussion