GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

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

Use Case Examples

  1. Fetch the pipeline schedule details for project ID 18 and pipeline schedule ID 13 to monitor scheduled CI/CD jobs.
  2. Use the node to get pipeline schedule information to trigger notifications or audits based on pipeline schedules.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication used, here it is GitLab API authentication.
baseUrl 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 pipeline schedule ID for the API request.

Output

JSON

  • id - The unique identifier of the pipeline schedule.
  • description - Description of the pipeline schedule.
  • ref - The Git reference (branch or tag) the pipeline schedule runs on.
  • cron - The 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.
  • owner - Information about the owner of the pipeline schedule.

Dependencies

  • GitLab API credentials for authentication

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correct and exist in the GitLab instance.
  • 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.
  • Common errors include 404 Not Found if the project or pipeline schedule does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion