Skip to content

Get jobs details based on filters

Request

Returns jobs in descending order with pagination based on jobType, status, projectId, triggeredBy, jobsHistoryInDays

Security
bearerAuth
Query
jobTypestring

Required param for jobType: Project Branching|Project Copy|Project Scan|Project Re-Scan|PDL Update|Project Deletion|Export to SBOM Insights|Update Notices|Project Import|Project Export|Remote Scan|Apply Policy - Global|Apply Policy - Project|Report - Audit Report|Report - Notices Report|Report - Project Report|Report - <Custom Report Name>

statusstring
Enum:"New""Active""Canceled""Completed""Failed""Scheduled""Terminated""Waiting on update"
projectIdinteger, (int32), >= 0

Id of the project (Example: 10)

triggeredBystring

Login Name of the user (Example: admin)

jobsHistoryInDaysinteger, (int32), [ 0 .. 3650 ]

Days in number. Get jobs in days. (Default=0, All the jobs will be fetched with other filters)

Default:0
limitinteger, (int32), >= 1

Page Size. Number Of Records to fetch per page

Default:25
offsetinteger, (int32), >= 1

Page Number. Index of the page to start with(starts from 1)

Default:1
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/jobs?jobType=string&status=New&projectId=0&triggeredBy=string&jobsHistoryInDays=0&limit=25&offset=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK