GitLab Pipeline schedules API

openapi: 3.2.0
info:
  title: GitLab REST Pipeline schedules API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Pipeline schedules
  description: Use this API to interact with pipeline schedules.
  x-displayName: Pipeline schedules
  externalDocs:
    url: https://docs.gitlab.com/api/pipeline_schedules/
paths:
  /api/v4/projects/{id}/pipeline_schedules:
    get:
      operationId: getApiV4ProjectsIdPipelineSchedules
      summary: List all pipeline schedules
      description: Lists all pipeline schedules for a project.
      tags:
      - Pipeline schedules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesCiPipelineSchedule'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      - name: scope
        required: false
        description: Scope of pipeline schedules.
        schema:
          type:
          - string
          - 'null'
          enum:
          - active
          - inactive
          - null
        in: query
        example: active
    post:
      operationId: postApiV4ProjectsIdPipelineSchedules
      summary: Create a pipeline schedule
      description: Creates a pipeline schedule.
      tags:
      - Pipeline schedules
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiPipelineScheduleDetails'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdPipelineSchedulesRequest'
  /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}:
    get:
      operationId: getApiV4ProjectsIdPipelineSchedulesPipelineScheduleId
      summary: Retrieve a pipeline schedule
      description: Retrieves a pipeline schedule for a project.
      tags:
      - Pipeline schedules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiPipelineScheduleDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: pipeline_schedule_id
        required: true
        description: ID of the pipeline schedule.
        schema:
          type: integer
        in: path
        example: 13
    put:
      operationId: putApiV4ProjectsIdPipelineSchedulesPipelineScheduleId
      summary: Update a pipeline schedule
      description: Updates a pipeline schedule for a project. After the update is done, it is rescheduled automatically.
      tags:
      - Pipeline schedules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiPipelineScheduleDetails'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: pipeline_schedule_id
        required: true
        description: ID of the pipeline schedule.
        schema:
          type: integer
        in: path
        example: 13
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdRequest'
    delete:
      operationId: deleteApiV4ProjectsIdPipelineSchedulesPipelineScheduleId
      summary: Delete a pipeline schedule
      description: Deletes a pipeline schedule for a project.
      tags:
      - Pipeline schedules
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '412':
          description: Precondition Failed
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: pipeline_schedule_id
        required: true
        description: ID of the pipeline schedule.
        schema:
          type: integer
        in: path
        example: 13
  /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/pipelines:
    get:
      operationId: getApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdPipelines
      summary: List all pipelines triggered by a pipeline schedule
      description: Lists all pipelines triggered by a pipeline schedule in a project.
      tags:
      - Pipeline schedules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesCiPipelineBasic'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      - name: pipeline_schedule_id
        required: true
        description: ID of the pipeline schedule.
        schema:
          type: integer
        in: path
        example: 13
      - name: scope
        required: false
        description: Return pipelines in the specified scope.
        schema:
          type:
          - string
          - 'null'
          enum:
          - running
          - pending
          - finished
          - branches
          - tags
          - null
        in: query
        example: pending
      - name: status
        required: false
        description: Return pipelines with the specified status.
        schema:
          type:
          - string
          - 'null'
          enum:
          - created
          - waiting_for_resource
          - preparing
          - waiting_for_callback
          - pending
          - running
          - success
          - failed
          - canceling
          - canceled
          - skipped
          - manual
          - scheduled
          - null
        in: query
        example: pending
      - name: updated_before
        required: false
        description: Return pipelines updated on or before the specified time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2015-12-24T15:51:21.880Z'
      - name: updated_after
        required: false
        description: Return pipelines updated on or after the specified time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2015-12-24T15:51:21.880Z'
      - name: created_before
        required: false
        description: Return pipelines created before the specified time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2015-12-24T15:51:21.880Z'
      - name: created_after
        required: false
        description: Return pipelines created after the specified time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2015-12-24T15:51:21.880Z'
      - name: sort
        required: false
        description: Sort results in ascending or descending order.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
        in: query
        example: desc
  /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/take_ownership:
    post:
      operationId: postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdTakeOwnership
      summary: Create or update ownership of a pipeline schedule
      description: Creates or updates the owner of a pipeline schedule for a project.
      tags:
      - Pipeline schedules
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiPipelineScheduleDetails'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: pipeline_schedule_id
        required: true
        description: ID of the pipeline schedule.
        schema:
          type: integer
        in: path
        example: 13
  /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/play:
    post:
      operationId: postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdPlay
      summary: Run a pipeline schedule
      description: Runs a pipeline schedule immediately. The next scheduled run of this pipeline is not affected.
      tags:
      - Pipeline schedules
      responses:
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: pipeline_schedule_id
        required: true
        description: ID of the pipeline schedule.
        schema:
          type: integer
        in: path
        example: 13
  /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables:
    post:
      operationId: postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariables
      summary: Create a variable for a pipeline schedule
      description: Creates a variable for a pipeline schedule.
      tags:
      - Pipeline schedules
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiVariable'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: pipeline_schedule_id
        required: true
        description: ID of the pipeline schedule.
        schema:
          type: integer
        in: path
        example: 13
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesRequest'
  /api/v4/projects/{id}/pipeline_schedules/{pipeline_schedule_id}/variables/{key}:
    get:
      operationId: getApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey
      summary: Retrieve a variable for a pipeline schedule
      description: Retrieves a specified variable for a pipeline schedule.
      tags:
      - Pipeline schedules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiVariable'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: pipeline_schedule_id
        required: true
        description: ID of the pipeline schedule.
        schema:
          type: integer
        in: path
        example: 13
      - name: key
        required: true
        description: Key of the pipeline schedule variable. Must be 255 characters or fewer and contain only `A-Z`, `a-z`, `0-9`, and `_`.
        schema:
          type: string
        in: path
        example: NEW_VARIABLE
    put:
      operationId: putApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey
      summary: Update a variable for a pipeline schedule
      description: Updates a variable for a pipeline schedule.
      tags:
      - Pipeline schedules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiVariable'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: pipeline_schedule_id
        required: true
        description: ID of the pipeline schedule.
        schema:
          type: integer
        in: path
        example: 13
      - name: key
        required: true
        description: Key of the pipeline schedule variable. Must be 255 characters or fewer and contain only `A-Z`, `a-z`, `0-9`, and `_`.
        schema:
          type: string
        in: path
        example: NEW_VARIABLE
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKeyRequest'
    delete:
      operationId: deleteApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKey
      summary: Delete a variable for a pipeline schedule
      description: Deletes a specified variable for a pipeline schedule.
      tags:
      - Pipeline schedules
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCiVariable'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 18
      - name: pipeline_schedule_id
        required: true
        description: ID of the pipeline schedule.
        schema:
          type: integer
        in: path
        example: 13
      - name: key
        required: true
        description: Key of the pipeline schedule variable. Must be 255 characters or fewer and contain only `A-Z`, `a-z`, `0-9`, and `_`.
        schema:
          type: string
        in: path
        example: NEW_VARIABLE
components:
  schemas:
    APIEntitiesCiInput:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    postApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesRequest:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
          description: Key of the pipeline schedule variable. Must be 255 characters or fewer and contain only `A-Z`, `a-z`, `0-9`, and `_`.
          example: NEW_VARIABLE
        value:
          type:
          - string
          - 'null'
          description: Value of the variable.
          example: new value
        variable_type:
          type:
          - string
          - 'null'
          enum:
          - env_var
          - file
          - null
          description: Type of the variable. Defaults to `env_var`.
      required:
      - key
      - value
    APIEntitiesCustomAttribute:
      type: object
      properties:
        key:
          type: string
          example: foo
        value:
          type: string
          example: bar
    putApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdRequest:
      type: object
      properties:
        description:
          type:
          - string
          - 'null'
          description: Description of the pipeline schedule.
          example: Test schedule pipeline
        ref:
          type:
          - string
          - 'null'
          description: Branch or tag name that triggers the pipeline. Accepts either short refs (`main`) or full refs (`refs/heads/main` or `refs/tags/main`). Short refs are automatically expanded to full refs, unless the value could match either a branch or a tag.
          example: develop
        cron:
          type:
          - string
          - 'null'
          description: Cron schedule, for example `0 1 * * *`.
          example: '* * * * *'
        cron_timezone:
          type:
          - string
          - 'null'
          description: Time zone supported by `ActiveSupport::TimeZone`, for example `Pacific Time (US & Canada)`, or `TZInfo::Timezone`, for example `America/Los_Angeles`.
          example: Asia/Tokyo
        active:
          type:
          - boolean
          - 'null'
          description: If `true`, activates the pipeline schedule. If `false`, the pipeline schedule is initially deactivated.
          example: true
        inputs:
          type:
          - array
          - 'null'
          description: Array of inputs to pass to the pipeline schedule. Each input has a `name` and a `value`, which can be a string, array, number, or boolean. To delete an existing input, include the `name` field and set `destroy` to `true`.
          items:
            type: object
            properties:
              name:
                type:
                - string
                - 'null'
                description: Name of the input.
                example: deploy_strategy
              destroy:
                type:
                - boolean
                - 'null'
                description: If `true`, deletes the input.
              value:
                oneOf:
                - type:
                  - string
                  - 'null'
                - type:
                  - array
                  - 'null'
                - type:
                  - number
                  - 'null'
                - type:
                  - boolean
                  - 'null'
                description: Value of the input.
            required:
            - name
            - value
    postApiV4ProjectsIdPipelineSchedulesRequest:
      type: object
      properties:
        description:
          type:
          - string
          - 'null'
          description: Description of the pipeline schedule.
          example: Test schedule pipeline
        ref:
          type:
          - string
          - 'null'
          description: Branch or tag name that triggers the pipeline. Accepts either short refs (`main`) or full refs (`refs/heads/main` or `refs/tags/main`). Short refs are automatically expanded to full refs, unless the value could match either a branch or a tag.
          example: develop
        cron:
          type:
          - string
          - 'null'
          description: Cron schedule, for example `0 1 * * *`.
          example: '* * * * *'
        cron_timezone:
          type: string
          description: Time zone supported by `ActiveSupport::TimeZone`, for example `Pacific Time (US & Canada)`, or `TZInfo::Timezone`, for example `America/Los_Angeles`.
          example: Asia/Tokyo
          default: UTC
        active:
          type: boolean
          description: If `true`, activates the pipeline schedule. If `false`, the pipeline schedule is initially deactivated.
          example: true
          default: true
        inputs:
          type:
          - array
          - 'null'
          description: Array of inputs to pass to the pipeline schedule. Each input has a `name` and a `value`, which can be a string, array, number, or boolean. To delete an existing input, include the `name` field and set `destroy` to `true`.
          items:
            type: object
            properties:
              name:
                type:
                - string
                - 'null'
                description: Name of the input.
                example: deploy_strategy
              value:
                oneOf:
                - type:
                  - string
                  - 'null'
                - type:
                  - array
                  - 'null'
                - type:
                  - number
                  - 'null'
                - type:
                  - boolean
                  - 'null'
                description: Value of the input.
            required:
            - name
            - value
      required:
      - description
      - ref
      - cron
    APIEntitiesCiPipelineSchedule:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 13
        description:
          type: string
          example: Test schedule pipeline
        ref:
          type: string
          example: develop
        cron:
          type: string
          example: '* * * * *'
        cron_timezone:
          type: string
          example: Asia/Tokyo
        next_run_at:
          type: string
          format: date-time
          example: '2017-05-19T13:41:00.000Z'
        active:
          type: boolean
          example: true
        created_at:
          type: string
          format: date-time
          example: '2017-05-19T13:31:08.849Z'
        updated_at:
          type: string
          format: date-time
          example: '2017-05-19T13:40:17.727Z'
        owner:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        inputs:
          $ref: '#/components/schemas/APIEntitiesCiInput'
    APIEntitiesCiPipelineScheduleDetails:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 13
        description:
          type: string
          example: Test schedule pipeline
        ref:
          type: string
          example: develop
        cron:
          type: string
          example: '* * * * *'
        cron_timezone:
          type: string
          example: Asia/Tokyo
        next_run_at:
          type: string
          format: date-time
          example: '2017-05-19T13:41:00.000Z'
        active:
          type: boolean
          example: true
        created_at:
          type: string
          format: date-time
          example: '2017-05-19T13:31:08.849Z'
        updated_at:
          type: string
          format: date-time
          example: '2017-05-19T13:40:17.727Z'
        owner:
          $ref: '#/components/schemas/APIEntitiesUserBasic'
        inputs:
          $ref: '#/components/schemas/APIEntitiesCiInput'
        last_pipeline:
          $ref: '#/components/schemas/APIEntitiesCiPipelineBasic'
        variables:
          $ref: '#/components/schemas/APIEntitiesCiVariable'
    APIEntitiesCiVariable:
      type: object
      properties:
        variable_type:
          type: string
          example: env_var
        key:
          type: string
          example: TEST_VARIABLE_1
        value:
          type: string
          example: TEST_1
        hidden:
          type: boolean
        protected:
          type: boolean
        masked:
          type: boolean
        raw:
          type: boolean
        environment_scope:
          type: string
          example: '*'
        description:
          type: string
          example: This variable is being used for ...
    APIEntitiesCiPipelineBasic:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        iid:
          type: integer
          example: 2
        project_id:
          type: integer
          format: int64
          example: 3
        sha:
          type: string
          example: 0ec9e58fdfca6cdd6652c083c9edb53abc0bad52
        ref:
          type: string
          example: feature-branch
        status:
          type: string
          example: success
        source:
          type: string
          example: push
        created_at:
          type: string
          format: date-time
          example: '2022-10-21T16:49:48.000+02:00'
        updated_at:
          type: string
          format: date-time
          example: '2022-10-21T16:49:48.000+02:00'
        web_url:
          type: string
          example: https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61
    putApiV4ProjectsIdPipelineSchedulesPipelineScheduleIdVariablesKeyRequest:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
          description: Value of the variable.
          example: new value
        variable_type:
          type:
          - string
          - 'null'
          enum:
          - env_var
          - file
          - null
          description: Type of the variable. Defaults to `env_var`.
    APIEntitiesUserBasic:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        username:
          type: string
          example: admin
        public_email:
          type: string
          example: john@example.com
        name:
          type: string
          example: Administrator
        state:
          type: string
          example: active
        locked:
          type: boolean
        avatar_url:
          type: string
          example: https://gravatar.com/avatar/1
        avatar_path:
          type: string
          example: /user/avatar/28/The-Big-Lebowski-400-400.png
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesCustomAttribute'
        web_url:
          type: string
          example: https://gitlab.example.com/root
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header