View
Learn how to inspect a schedule.
Endpoint
GET /api/v1/schedules/:org/:repo/:schedule
Parameters
The following parameters are used to configure the endpoint:
Name | Description |
---|---|
org | name of organization |
repo | name of repository |
schedule | name of schedule from repository |
Permissions
COMING SOON!
Responses
Status Code | Description |
---|---|
200 | indicates the request has succeeded |
400 | unable to retrieve the schedule |
401 | indicates the user does not have proper permissions |
404 | unable to retrieve the schedule |
Sample
This section assumes you already know how to authenticate to the API.
To authenticate to the API, please review the authentication documentation.
Request
curl \
-X GET \
-H "Authorization: Bearer <token>" \
"http://127.0.0.1:8080/api/v1/schedules/github/octocat/hourly"
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
}
Last modified June 24, 2024: Update Schedule API response examples (#412) (5fc450e3)