You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/job-apis.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,17 @@
1
-
# Job Logs APIs
1
+
# Job APIs
2
2
3
3
Job Logs APIs provide a summary of and content for the Job Logs generated by the Renovate CLI.
4
4
5
-
## Available Job Logs APIs
5
+
The Run Job API schedules a Renovate job to run against a given repository.
6
+
7
+
## Available Job APIs
6
8
7
9
The list below describes the available Job Logs APIs. Follow the links on the API names for full details.
8
10
9
11
-[List Jobs by Repo](#list-jobs-by-repo) ← Lists all jobs for a given repo
10
12
-[Get Job Logs by Repo](#get-job-logs-by-repo) ← Fetch job logs for a given repo (latest, or by JobID)
11
13
-[Get Job Logs by JobID](#get-job-logs-by-jobid) ← Fetch job logs by Job ID
14
+
-[Run Job on a Repo](#run-job-on-a-repo) ← Run a Renovate job against a given repo
12
15
13
16
## Enable Job Logs APIs
14
17
@@ -35,6 +38,7 @@ See the table below for a list of Job Logs API URL formats.
35
38
|[List Jobs by Repo](#list-jobs-by-repo)|[GET] /api/repos/{org}/{repo}/-/jobs | limit (default=100, max=10,000) |
36
39
|[Get Job Logs by Repo](#get-job-logs-by-repo)|[GET] /api/repos/{org}/{repo}/-/jobs/<latest\|{jobId}> ||
37
40
|[Get Job Logs by JobID](#get-job-logs-by-jobid)|[GET] /api/job/logs/{jobId} ||
41
+
|[Run Job on a Repo](#run-job-on-a-repo)|[POST] /api/repos/{org}/{repo}/-/jobs/run ||
38
42
39
43
## Details of Job Logs APIs
40
44
@@ -142,3 +146,9 @@ Note: This returns the same as [Get Job Logs by Repo](#get-job-logs-by-repo) wit
142
146
{"name":"renovate","hostname":"271939e11491","pid":21,"level":20,"logContext":"5a3572bf-49fe-42bb-a066-ff1146fe83d1","msg":"Verifying and cleaning cache: /tmp/renovate/cache/renovate/renovate-cache-v1","time":"2024-05-13T12:42:29.521Z","v":0}
143
147
{"name":"renovate","hostname":"271939e11491","pid":21,"level":20,"logContext":"5a3572bf-49fe-42bb-a066-ff1146fe83d1","msg":"Deleted 0 of 29 file cached entries in 840ms","time":"2024-05-13T12:42:30.193Z","v":0}
144
148
```
149
+
150
+
### Run Job on a Repo
151
+
152
+
API: [POST] /api/repos/{org}/{repo}/-/jobs/run
153
+
154
+
**Description:** Schedules a job to run Renovate on the given repository
0 commit comments