List all pipeline schedules

GET

/api/v4/projects/{id}/pipeline_schedules

Lists all pipeline schedules for a project.

Authorizations

http
oauth2

Parameters

Path Parameters

required

One of:

string
integer

string

The ID or URL-encoded path of the project

Example

Query Parameters

page

integer

default: 1 nullable

Current page number

Example

per_page

integer

default: 20 nullable

Number of items per page

Example

scope

string

nullable

Allowed values: active inactive

The scope of pipeline schedules

Example

active

Responses

200

application/json

object

integer format: int64

description

string

ref

string

cron

string

cron_timezone

string

next_run_at

string format: date-time

active

boolean

created_at

string format: date-time

updated_at

string format: date-time

owner

object

integer format: int64

username

string

public_email

string

name

string

state

string

locked

boolean

avatar_url

string

avatar_path

string

custom_attributes

Array<object>

object

key

string

value

string

web_url

string

inputs

object

name

string

value

string

Example

{
  "id": 13,
  "description": "Test schedule pipeline",
  "ref": "develop",
  "cron": "* * * * *",
  "cron_timezone": "Asia/Tokyo",
  "next_run_at": "2017-05-19T13:41:00.000Z",
  "active": true,
  "created_at": "2017-05-19T13:31:08.849Z",
  "updated_at": "2017-05-19T13:40:17.727Z",
  "owner": {
    "id": 1,
    "username": "admin",
    "public_email": "john@example.com",
    "name": "Administrator",
    "state": "active",
    "avatar_url": "https://gravatar.com/avatar/1",
    "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
    "custom_attributes": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "web_url": "https://gitlab.example.com/root"
  }
}

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found