1. Packages
  2. Packages
  3. Gitlab Provider
  4. API Docs
  5. getPipelineSchedule
Viewing docs for GitLab v9.11.0
published on Tuesday, Apr 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

gitlab.getPipelineSchedule

gitlab logo
Viewing docs for GitLab v9.11.0
published on Tuesday, Apr 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

    The gitlab.PipelineSchedule data source retrieves information about a gitlab pipeline schedule for a project.

    Upstream API: GitLab REST API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = gitlab.getPipelineSchedule({
    project: "12345",
    pipelineScheduleId: 1,
});

    import pulumi
import pulumi_gitlab as gitlab

example = gitlab.get_pipeline_schedule(project="12345",
    pipeline_schedule_id=1)

    package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v9/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.GetPipelineSchedule(ctx, &gitlab.LookupPipelineScheduleArgs{
			Project:            "12345",
			PipelineScheduleId: 1,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var example = GitLab.Index.GetPipelineSchedule.Invoke(new()
    {
        Project = "12345",
        PipelineScheduleId = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetPipelineScheduleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = GitlabFunctions.getPipelineSchedule(GetPipelineScheduleArgs.builder()
            .project("12345")
            .pipelineScheduleId(1)
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: gitlab:getPipelineSchedule
      arguments:
        project: '12345'
        pipelineScheduleId: 1

    Example coming soon!

    Using getPipelineSchedule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPipelineSchedule(args: GetPipelineScheduleArgs, opts?: InvokeOptions): Promise<GetPipelineScheduleResult>
function getPipelineScheduleOutput(args: GetPipelineScheduleOutputArgs, opts?: InvokeOptions): Output<GetPipelineScheduleResult>
    def get_pipeline_schedule(cron_timezone: Optional[str] = None,
                          pipeline_schedule_id: Optional[int] = None,
                          project: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPipelineScheduleResult
def get_pipeline_schedule_output(cron_timezone: pulumi.Input[Optional[str]] = None,
                          pipeline_schedule_id: pulumi.Input[Optional[int]] = None,
                          project: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPipelineScheduleResult]
    func LookupPipelineSchedule(ctx *Context, args *LookupPipelineScheduleArgs, opts ...InvokeOption) (*LookupPipelineScheduleResult, error)
func LookupPipelineScheduleOutput(ctx *Context, args *LookupPipelineScheduleOutputArgs, opts ...InvokeOption) LookupPipelineScheduleResultOutput

    > Note: This function is named LookupPipelineSchedule in the Go SDK.

    public static class GetPipelineSchedule 
{
    public static Task<GetPipelineScheduleResult> InvokeAsync(GetPipelineScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineScheduleResult> Invoke(GetPipelineScheduleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPipelineScheduleResult> getPipelineSchedule(GetPipelineScheduleArgs args, InvokeOptions options)
public static Output<GetPipelineScheduleResult> getPipelineSchedule(GetPipelineScheduleArgs args, InvokeOptions options)

    fn::invoke:
  function: gitlab:index/getPipelineSchedule:getPipelineSchedule
  arguments:
    # arguments dictionary
    data "gitlab_getpipelineschedule" "name" {
    # arguments
}

    The following arguments are supported:

    PipelineScheduleId int
    The pipeline schedule id.
    Project string
    The name or id of the project to add the schedule to.
    CronTimezone string
    The timezone.
    PipelineScheduleId int
    The pipeline schedule id.
    Project string
    The name or id of the project to add the schedule to.
    CronTimezone string
    The timezone.
    pipeline_schedule_id number
    The pipeline schedule id.
    project string
    The name or id of the project to add the schedule to.
    cron_timezone string
    The timezone.
    pipelineScheduleId Integer
    The pipeline schedule id.
    project String
    The name or id of the project to add the schedule to.
    cronTimezone String
    The timezone.
    pipelineScheduleId number
    The pipeline schedule id.
    project string
    The name or id of the project to add the schedule to.
    cronTimezone string
    The timezone.
    pipeline_schedule_id int
    The pipeline schedule id.
    project str
    The name or id of the project to add the schedule to.
    cron_timezone str
    The timezone.
    pipelineScheduleId Number
    The pipeline schedule id.
    project String
    The name or id of the project to add the schedule to.
    cronTimezone String
    The timezone.

    getPipelineSchedule Result

    The following output properties are available:

    Active bool
    The activation status of pipeline schedule.
    CreatedAt string
    The datetime of when the schedule was created.
    Cron string
    The cron (e.g. 0 1 * * *).
    CronTimezone string
    The timezone.
    Description string
    The description of the pipeline schedule.
    Id string
    The ID of this Terraform resource. In the format of <project-id>:<pipeline-schedule-id>.
    Inputs List<Pulumi.GitLab.Outputs.GetPipelineScheduleInput>
    List of pipeline schedule inputs. Each element has name and value.
    LastPipeline Pulumi.GitLab.Outputs.GetPipelineScheduleLastPipeline
    The details of the last pipeline run by the schedule.
    NextRunAt string
    The datetime of when the schedule will next run.
    Owner Pulumi.GitLab.Outputs.GetPipelineScheduleOwner
    The details of the pipeline schedule owner.
    PipelineScheduleId int
    The pipeline schedule id.
    Project string
    The name or id of the project to add the schedule to.
    Ref string
    The branch/tag name to be triggered. This will be the full branch reference, for example: refs/heads/main, not main.
    UpdatedAt string
    The datetime of when the schedule was last updated.
    Variables List<Pulumi.GitLab.Outputs.GetPipelineScheduleVariable>
    The list of the pipeline schedule variables.
    Active bool
    The activation status of pipeline schedule.
    CreatedAt string
    The datetime of when the schedule was created.
    Cron string
    The cron (e.g. 0 1 * * *).
    CronTimezone string
    The timezone.
    Description string
    The description of the pipeline schedule.
    Id string
    The ID of this Terraform resource. In the format of <project-id>:<pipeline-schedule-id>.
    Inputs []GetPipelineScheduleInput
    List of pipeline schedule inputs. Each element has name and value.
    LastPipeline GetPipelineScheduleLastPipeline
    The details of the last pipeline run by the schedule.
    NextRunAt string
    The datetime of when the schedule will next run.
    Owner GetPipelineScheduleOwner
    The details of the pipeline schedule owner.
    PipelineScheduleId int
    The pipeline schedule id.
    Project string
    The name or id of the project to add the schedule to.
    Ref string
    The branch/tag name to be triggered. This will be the full branch reference, for example: refs/heads/main, not main.
    UpdatedAt string
    The datetime of when the schedule was last updated.
    Variables []GetPipelineScheduleVariableType
    The list of the pipeline schedule variables.
    active bool
    The activation status of pipeline schedule.
    created_at string
    The datetime of when the schedule was created.
    cron string
    The cron (e.g. 0 1 * * *).
    cron_timezone string
    The timezone.
    description string
    The description of the pipeline schedule.
    id string
    The ID of this Terraform resource. In the format of <project-id>:<pipeline-schedule-id>.
    inputs list(object)
    List of pipeline schedule inputs. Each element has name and value.
    last_pipeline object
    The details of the last pipeline run by the schedule.
    next_run_at string
    The datetime of when the schedule will next run.
    owner object
    The details of the pipeline schedule owner.
    pipeline_schedule_id number
    The pipeline schedule id.
    project string
    The name or id of the project to add the schedule to.
    ref string
    The branch/tag name to be triggered. This will be the full branch reference, for example: refs/heads/main, not main.
    updated_at string
    The datetime of when the schedule was last updated.
    variables list(object)
    The list of the pipeline schedule variables.
    active Boolean
    The activation status of pipeline schedule.
    createdAt String
    The datetime of when the schedule was created.
    cron String
    The cron (e.g. 0 1 * * *).
    cronTimezone String
    The timezone.
    description String
    The description of the pipeline schedule.
    id String
    The ID of this Terraform resource. In the format of <project-id>:<pipeline-schedule-id>.
    inputs List<GetPipelineScheduleInput>
    List of pipeline schedule inputs. Each element has name and value.
    lastPipeline GetPipelineScheduleLastPipeline
    The details of the last pipeline run by the schedule.
    nextRunAt String
    The datetime of when the schedule will next run.
    owner GetPipelineScheduleOwner
    The details of the pipeline schedule owner.
    pipelineScheduleId Integer
    The pipeline schedule id.
    project String
    The name or id of the project to add the schedule to.
    ref String
    The branch/tag name to be triggered. This will be the full branch reference, for example: refs/heads/main, not main.
    updatedAt String
    The datetime of when the schedule was last updated.
    variables List<GetPipelineScheduleVariable>
    The list of the pipeline schedule variables.
    active boolean
    The activation status of pipeline schedule.
    createdAt string
    The datetime of when the schedule was created.
    cron string
    The cron (e.g. 0 1 * * *).
    cronTimezone string
    The timezone.
    description string
    The description of the pipeline schedule.
    id string
    The ID of this Terraform resource. In the format of <project-id>:<pipeline-schedule-id>.
    inputs GetPipelineScheduleInput[]
    List of pipeline schedule inputs. Each element has name and value.
    lastPipeline GetPipelineScheduleLastPipeline
    The details of the last pipeline run by the schedule.
    nextRunAt string
    The datetime of when the schedule will next run.
    owner GetPipelineScheduleOwner
    The details of the pipeline schedule owner.
    pipelineScheduleId number
    The pipeline schedule id.
    project string
    The name or id of the project to add the schedule to.
    ref string
    The branch/tag name to be triggered. This will be the full branch reference, for example: refs/heads/main, not main.
    updatedAt string
    The datetime of when the schedule was last updated.
    variables GetPipelineScheduleVariable[]
    The list of the pipeline schedule variables.
    active bool
    The activation status of pipeline schedule.
    created_at str
    The datetime of when the schedule was created.
    cron str
    The cron (e.g. 0 1 * * *).
    cron_timezone str
    The timezone.
    description str
    The description of the pipeline schedule.
    id str
    The ID of this Terraform resource. In the format of <project-id>:<pipeline-schedule-id>.
    inputs Sequence[GetPipelineScheduleInput]
    List of pipeline schedule inputs. Each element has name and value.
    last_pipeline GetPipelineScheduleLastPipeline
    The details of the last pipeline run by the schedule.
    next_run_at str
    The datetime of when the schedule will next run.
    owner GetPipelineScheduleOwner
    The details of the pipeline schedule owner.
    pipeline_schedule_id int
    The pipeline schedule id.
    project str
    The name or id of the project to add the schedule to.
    ref str
    The branch/tag name to be triggered. This will be the full branch reference, for example: refs/heads/main, not main.
    updated_at str
    The datetime of when the schedule was last updated.
    variables Sequence[GetPipelineScheduleVariable]
    The list of the pipeline schedule variables.
    active Boolean
    The activation status of pipeline schedule.
    createdAt String
    The datetime of when the schedule was created.
    cron String
    The cron (e.g. 0 1 * * *).
    cronTimezone String
    The timezone.
    description String
    The description of the pipeline schedule.
    id String
    The ID of this Terraform resource. In the format of <project-id>:<pipeline-schedule-id>.
    inputs List<Property Map>
    List of pipeline schedule inputs. Each element has name and value.
    lastPipeline Property Map
    The details of the last pipeline run by the schedule.
    nextRunAt String
    The datetime of when the schedule will next run.
    owner Property Map
    The details of the pipeline schedule owner.
    pipelineScheduleId Number
    The pipeline schedule id.
    project String
    The name or id of the project to add the schedule to.
    ref String
    The branch/tag name to be triggered. This will be the full branch reference, for example: refs/heads/main, not main.
    updatedAt String
    The datetime of when the schedule was last updated.
    variables List<Property Map>
    The list of the pipeline schedule variables.

    Supporting Types

    GetPipelineScheduleInput

    Name string
    The name of the input.
    Value string
    The value of the input.
    Name string
    The name of the input.
    Value string
    The value of the input.
    name string
    The name of the input.
    value string
    The value of the input.
    name String
    The name of the input.
    value String
    The value of the input.
    name string
    The name of the input.
    value string
    The value of the input.
    name str
    The name of the input.
    value str
    The value of the input.
    name String
    The name of the input.
    value String
    The value of the input.

    GetPipelineScheduleLastPipeline

    Id int
    The pipeline ID.
    Ref string
    The ref of the pipeline.
    Sha string
    The SHA of the pipeline.
    Status string
    The status of pipelines, one of: created, waitingforresource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled.
    Id int
    The pipeline ID.
    Ref string
    The ref of the pipeline.
    Sha string
    The SHA of the pipeline.
    Status string
    The status of pipelines, one of: created, waitingforresource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled.
    id number
    The pipeline ID.
    ref string
    The ref of the pipeline.
    sha string
    The SHA of the pipeline.
    status string
    The status of pipelines, one of: created, waitingforresource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled.
    id Integer
    The pipeline ID.
    ref String
    The ref of the pipeline.
    sha String
    The SHA of the pipeline.
    status String
    The status of pipelines, one of: created, waitingforresource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled.
    id number
    The pipeline ID.
    ref string
    The ref of the pipeline.
    sha string
    The SHA of the pipeline.
    status string
    The status of pipelines, one of: created, waitingforresource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled.
    id int
    The pipeline ID.
    ref str
    The ref of the pipeline.
    sha str
    The SHA of the pipeline.
    status str
    The status of pipelines, one of: created, waitingforresource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled.
    id Number
    The pipeline ID.
    ref String
    The ref of the pipeline.
    sha String
    The SHA of the pipeline.
    status String
    The status of pipelines, one of: created, waitingforresource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled.

    GetPipelineScheduleOwner

    AvatarUrl string
    Image URL for the user's avatar.
    Id int
    The user ID.
    Name string
    Name.
    State string
    User's state, one of: active, blocked.
    Username string
    Username.
    WebUrl string
    URL to the user's profile.
    AvatarUrl string
    Image URL for the user's avatar.
    Id int
    The user ID.
    Name string
    Name.
    State string
    User's state, one of: active, blocked.
    Username string
    Username.
    WebUrl string
    URL to the user's profile.
    avatar_url string
    Image URL for the user's avatar.
    id number
    The user ID.
    name string
    Name.
    state string
    User's state, one of: active, blocked.
    username string
    Username.
    web_url string
    URL to the user's profile.
    avatarUrl String
    Image URL for the user's avatar.
    id Integer
    The user ID.
    name String
    Name.
    state String
    User's state, one of: active, blocked.
    username String
    Username.
    webUrl String
    URL to the user's profile.
    avatarUrl string
    Image URL for the user's avatar.
    id number
    The user ID.
    name string
    Name.
    state string
    User's state, one of: active, blocked.
    username string
    Username.
    webUrl string
    URL to the user's profile.
    avatar_url str
    Image URL for the user's avatar.
    id int
    The user ID.
    name str
    Name.
    state str
    User's state, one of: active, blocked.
    username str
    Username.
    web_url str
    URL to the user's profile.
    avatarUrl String
    Image URL for the user's avatar.
    id Number
    The user ID.
    name String
    Name.
    state String
    User's state, one of: active, blocked.
    username String
    Username.
    webUrl String
    URL to the user's profile.

    GetPipelineScheduleVariable

    Key string
    The key of a variable.
    Value string
    The value of a variable.
    VariableType string
    The type of a variable, one of: envVar and file.
    Key string
    The key of a variable.
    Value string
    The value of a variable.
    VariableType string
    The type of a variable, one of: envVar and file.
    key string
    The key of a variable.
    value string
    The value of a variable.
    variable_type string
    The type of a variable, one of: envVar and file.
    key String
    The key of a variable.
    value String
    The value of a variable.
    variableType String
    The type of a variable, one of: envVar and file.
    key string
    The key of a variable.
    value string
    The value of a variable.
    variableType string
    The type of a variable, one of: envVar and file.
    key str
    The key of a variable.
    value str
    The value of a variable.
    variable_type str
    The type of a variable, one of: envVar and file.
    key String
    The key of a variable.
    value String
    The value of a variable.
    variableType String
    The type of a variable, one of: envVar and file.

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    Viewing docs for GitLab v9.11.0
    published on Tuesday, Apr 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gitlab
      Try Pulumi Cloud free. Your team will thank you.