Return pipeline schedule variables in "Get Pipeline Variables" API endpoint
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Customer Use Cases
Based on the issue discussion, here are the key customer use cases for returning pipeline schedule variables in the API:
1. Pipeline Monitoring & Reporting Customers want to build monitoring dashboards and reports that group pipelines by type. Since different pipeline types are often toggled via variables (either manual or schedule-based), they need access to schedule variables to properly categorize and report on pipeline executions.
2. Multi-Workflow Pipeline Management Large projects often use a single pipeline definition with multiple workflows (dependency updates, smoke tests, daily builds, nightly tests, etc.) controlled by variables. Customers need to retrieve these variables via API or webhooks to understand which workflow was triggered.
3. Child Pipeline Variable Passing Customers attempting to pass variables from parent to child pipelines want to use the API to retrieve schedule variables instead of manually managing dotenv files. This reduces error-prone manual configuration.
4. Pipeline Segregation & Automation Customers need variables to segregate different pipeline types for creating reports and automating downstream processes. Without access to schedule variables, they can't properly identify which pipeline variant was executed.
5. Webhook-Based Automation Customers using webhooks to trigger external systems need to access schedule variables to understand the context and type of pipeline that was executed.
Proposal
The https://docs.gitlab.com/ee/api/pipelines.html#get-variables-of-a-pipeline currently only returns manual pipeline variables.
Users also want to see pipeline schedule variables for a given pipeline.