Onboarding Sessions

Download an onboarding session report

GET/onboarding-sessions/{id}/report/download
onboarding:readget_onboarding_session_report_downloadRead-only

Streams the report as an A4 portrait PDF, rendered in the request with no job. It uses the report stored when the session was completed or reset on a versioned flow, and otherwise renders it live. Content-Disposition is an attachment named <flow name> report.pdf, with /, \\ and control characters in the name replaced by -. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The onboarding session's id, a uuid. An unknown id, or a session you cannot see, returns 404.

Responses

200

The report as a PDF.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/onboarding-sessions/{id}/report/download\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"