ESescape
Jobs
Beta

Trigger a template export job

Schedules the same export job as the product UI (SAAS_EXPORT_TEMPLATE): PDF/report blocks, optional scan and issue scope. Use GET /jobs/{jobId} to read status and artefact download URLs when completed.

post/jobs

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Request body

namestring

Report name (optional).

scanIdstring uuid

Restrict scope to a scan (optional).

dryboolean

If true, validates selection only and does not schedule a job.

notifyboolean

If false, skip the email notification when the report is ready. Defaults to true.

assetWhereunknown
profileWhereunknown
issueWhereunknown

Response

OK

idstring uuid required

ID of the scheduled export job (template generation).

Changes

No recorded changes to this operation across all 1 revision of this API.