GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves details of a specific pipeline schedule for a given project in GitLab using the GitLab API v4. It is useful for automation workflows that need to fetch pipeline schedule information, such as monitoring scheduled pipelines or integrating pipeline schedules into other systems.

Use Case Examples

  1. Fetch pipeline schedule details for project ID 18 and pipeline schedule ID 13 to monitor scheduled CI/CD jobs.
  2. Integrate GitLab pipeline schedule data into a reporting dashboard by retrieving schedule details programmatically.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated API access.
Authentication Type of authentication used, here it is GitLab API authentication, hidden if Skip Authentication is true.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method for the API request, default is GET.
Parameter Schema Defines required path parameters for the API call: project ID and pipeline schedule ID.
Request Body Schema Schema for the request body, null for this GET operation.
Request Path API endpoint path with placeholders for project ID and pipeline schedule ID.
Path Parameters Collection of path parameters including 'id' (project ID or URL-encoded path) and 'pipeline_schedule_id' (pipeline schedule identifier).

Output

JSON

  • id - The unique identifier of the pipeline schedule.
  • description - Description of the pipeline schedule.
  • ref - The Git reference (branch or tag) the schedule runs on.
  • cron - Cron syntax defining the schedule timing.
  • cron_timezone - Timezone for the cron schedule.
  • next_run_at - Timestamp of the next scheduled run.
  • active - Boolean indicating if the schedule is active.
  • created_at - Timestamp when the schedule was created.
  • updated_at - Timestamp when the schedule was last updated.

Dependencies

  • GitLab API credentials for authentication

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correct and exist in the GitLab instance to avoid 404 errors.
  • Check that the GitLab API credentials are valid and have sufficient permissions to access pipeline schedules.
  • If skipping authentication, verify that the GitLab instance allows unauthenticated access to the requested resource.

Links

Discussion