GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves upcoming jobs for a specific resource group within a GitLab project using the GitLab API v4. It is useful for monitoring and managing CI/CD pipeline jobs that are scheduled to run soon, helping DevOps teams track job statuses and plan resource allocation effectively. For example, it can be used to fetch upcoming jobs for a resource group to display in a dashboard or trigger further automation based on job schedules.

Use Case Examples

  1. Fetch upcoming CI jobs for a resource group in a project to monitor pipeline activity.
  2. Retrieve paginated lists of upcoming jobs to analyze workload distribution across resource groups.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, defaulting to 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, and pagination parameters.
Query Parameters Optional query parameters for pagination: page number and items per page.
Path Parameters Required path parameters: project ID and resource group key to identify the resource group within the project.

Output

JSON

  • jobs - Array of upcoming job objects for the specified resource group.
  • pagination
    • page - Current page number of the results.
    • per_page - Number of items per page.
    • total - Total number of upcoming jobs available.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and resource group key are correctly specified; incorrect values will result in errors or empty responses.
  • Authentication errors may occur if the API key is missing or invalid; verify credentials are correctly configured.
  • Pagination parameters should be valid integers; invalid values may cause request failures or unexpected results.

Links

Discussion