project_pipeline_schedules

Gets or lists a project_pipeline_schedules resource.

Overview

Name	project_pipeline_schedules
Type	Resource
Id	gitlab.ci.project_pipeline_schedules

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the pipeline schedule.
active	boolean	Indicates if the pipeline schedule is active.
created_at	string	Timestamp of when the pipeline schedule was created.
cron	string	Cron notation for the schedule.
cron_timezone	string	Timezone for the pipeline schedule.
description	string	Description of the pipeline schedule.
edit_path	string	Edit path of the pipeline schedule.
for_tag	boolean	Indicates if a pipelines schedule belongs to a tag.
next_run_at	string	Time when the next pipeline will run.
project	object	Project identity (id, full_path, name)
real_next_run	string	Time when the next pipeline will run.
ref	string	Ref of the pipeline schedule.
ref_for_display	string	Git ref for the pipeline schedule.
ref_path	string	Path to the ref that triggered the pipeline.
updated_at	string	Timestamp of when the pipeline schedule was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	sort, status	Pipeline schedules of the project. This field can only be resolved for one project per request. Generated from the GitLab GraphQL schema field Project.pipelineSchedules (connection of PipelineSchedule nodes).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
full_path	string	Full path of the project, for example gitlab-org/gitlab
host	string	GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)
sort	string	List pipeline schedules by sort order. Default is id_desc.
status	string	Filter pipeline schedules by active status.

SELECT examples

list

Pipeline schedules of the project. This field can only be resolved for one project per request. Generated from the GitLab GraphQL schema field Project.pipelineSchedules (connection of PipelineSchedule nodes).

SELECT
id,
active,
created_at,
cron,
cron_timezone,
description,
edit_path,
for_tag,
next_run_at,
project,
real_next_run,
ref,
ref_for_display,
ref_path,
updated_at
FROM gitlab.ci.project_pipeline_schedules
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND sort = '{{ sort }}'
AND status = '{{ status }}'
;