GIgitlab
pipeline_schedules

List all pipeline schedules

Lists all pipeline schedules for a project.

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

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID or URL-encoded path of the project

Query parameters

pageinteger

Current page number

per_pageinteger

Number of items per page

scope'active' | 'inactive'

The scope of pipeline schedules

Response

List all pipeline schedules

idinteger required
descriptionstring required
refstring required
cronstring required
cron_timezonestring required
next_run_atstring date-time required
activeboolean required
created_atstring date-time required
updated_atstring date-time required

Example response

[
  {
    "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"
    }
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.