The Jobs API allows callers to manage running background jobs.

Request

Fetches information about background jobs. Returns empty array if no jobs are running.

Security
Bearer
curl -i -X GET \
  https://xmapps-api.sitecorecloud.io/api/v1/jobs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
Array [
namestring or null
queueTimestring, (date-time)
endTimestring or null, (date-time)
handlestring or null
sitestring or null
siteCollectionstring or null
statusstring, (int32)(JobStatus)
Enum:"Queued""Running""Completed""Failed"
jobTypestring or null
statisticsobject(JobStatisticsDto)
donebooleandeprecated
]
Response
[ { "name": "string", "done": true, "queueTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "handle": "string", "site": "string", "siteCollection": "string", "status": "Queued", "jobType": "string", "statistics": { … } } ]