Get

Learn how to list schedules.

Endpoint

GET  /api/v1/schedules/:org/:repo

Parameters

The following parameters are used to configure the endpoint:

NameDescription
orgname of organization
reponame of repository

Permissions

COMING SOON!

Responses

Status CodeDescription
200indicates the request has succeeded
400unable to retrieve the schedules
401indicates the user does not have proper permissions
404unable to retrieve the schedules
500system error while retrieving the schedules

Sample

Request

curl \
  -X GET \
  -H "Authorization: Bearer <token>" \
  "http://127.0.0.1:8080/api/v1/schedules/github/octocat"

Response

[
	{
		"id": 1,
		"repo": {
			"id": 1,
			"owner": {
				"id": 1,
				"name": "octokitty",
				"active": true
			},
			"org": "github",
			"name": "octokitty",
			"full_name": "github/octokitty",
			"link": "https://github.com/github/octokitty",
			"clone": "https://github.com/github/octokitty.git",
			"branch": "main",
			"topics": [],
			"build_limit": 10,
			"timeout": 30,
			"counter": 0,
			"visibility": "public",
			"private": false,
			"trusted": false,
			"active": true,
			"allow_events": {
				"push": {
					"branch": true,
					"tag": false,
					"delete_branch": false,
					"delete_tag": false
				},
				"pull_request": {
					"opened": false,
					"edited": false,
					"synchronize": false,
					"reopened": false,
					"labeled": false,
					"unlabeled": false
				},
				"deployment": {
					"created": false
				},
				"comment": {
					"created": false,
					"edited": false
				},
				"schedule": {
					"run": false
				}
			},
			"pipeline_type": "yaml",
			"previous_name": "",
			"approve_build": "fork-always"
		},
		"active": true,
		"name": "hourly",
		"entry": "0 * * * *",
		"created_at": 1716495910,
		"created_by": "octokitty",
		"updated_at": 1716495910,
		"updated_by": "octokitty",
		"scheduled_at": 0,
		"branch": "main",
		"error": "",
		"next_run": 1716499800
	},
	{
		"id": 2,
		"repo": {
			"id": 1,
			"owner": {
				"id": 1,
				"name": "octokitty",
				"active": true
			},
			"org": "github",
			"name": "octokitty",
			"full_name": "github/octokitty",
			"link": "https://github.com/github/octokitty",
			"clone": "https://github.com/github/octokitty.git",
			"branch": "main",
			"topics": [],
			"build_limit": 10,
			"timeout": 30,
			"counter": 0,
			"visibility": "public",
			"private": false,
			"trusted": false,
			"active": true,
			"allow_events": {
				"push": {
					"branch": true,
					"tag": false,
					"delete_branch": false,
					"delete_tag": false
				},
				"pull_request": {
					"opened": false,
					"edited": false,
					"synchronize": false,
					"reopened": false,
					"labeled": false,
					"unlabeled": false
				},
				"deployment": {
					"created": false
				},
				"comment": {
					"created": false,
					"edited": false
				},
				"schedule": {
					"run": false
				}
			},
			"pipeline_type": "yaml",
			"previous_name": "",
			"approve_build": "fork-always"
		},
		"active": true,
		"name": "nightly",
		"entry": "0 0 * * *",
		"created_at": 1716495910,
		"created_by": "octokitty",
		"updated_at": 1716495910,
		"updated_by": "octokitty",
		"scheduled_at": 0,
		"branch": "main",
		"error": "",
		"next_run": 1716499800
	}
]