Skip to main content

Get a job

GET 

/nevisadmin/api/v1/jobs/:jobId

Required permission: Only the user who started the job.

Required permission: SUPER_ADMIN (To access jobs the caller did not start.)

Get the job status.

  • If progress is 0, startTime has no value and endTime has no value → pending
  • If progress is 0 ≤ p < 1, startTime has value and endTime has no value → running
  • If progress is 0 ≤ p < 1, startTime has value and endTime has value → failed
  • If progress is 1, startTime has value and endTime has value → done

Request

Responses

Success