Get onboarding job status

GET

/api/v1/onboarding/status/{jobId}

const url = 'http://localhost:11044/api/v1/onboarding/status/example';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/onboarding/status/example \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

jobId

required

string

Job id (a UUID) returned by POST /onboarding/run. Jobs are held in this server’s memory only, so a restart forgets them; a job that finished more than an hour ago is answered once more and then removed, after which it answers 404

Responses

404

No onboarding job of that id: either it never existed, or it finished over an hour ago and the next status call cleaned it up