IRironcladapp
Exports

Check Data Export Job Status

View the status of an export job using the job id returned during job creation.

OAuth Scope required: public.export.readReports

The Data Export feature is part of the paid Security & Data Pro add-on. Contact your Ironclad account representative for more information about purchasing this package.

get/exports/{jobId}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/exports/{jobId}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.export.readReports

Path parameters

jobIdstring required

The job id to be checked.

Response

200

jobIdstring
jobStatus'pending' | 'running' | 'done' | 'failed'

Example response

{
  "jobId": "02e1343b-d024-4de0-a22e-a579282f05d9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.