ETethiack
reports

Get a single report

Return one report by id (404 if not found or not authorized).

Access is restricted to integrators (organization, partner) for organizations with the report feature enabled.

Args: report_id (int): Primary key of the report. db (AsyncSession): Request-scoped database session. context (ActiveContext): Resolved caller identity and scope.

Returns: ReportDetailResponse: The requested report.

get/v1/reports/{report_id}/

Request

  • Base URL
    https://api.ethiack.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

report_idinteger required

Response

Successful Response

idinteger required
pentest_slugstring nullable
optionsobject

Generation options this report was requested with. Empty for types that take none.

document_typestring required
statusinteger required
urlstring nullable
start_datestring date-time nullable
end_datestring date-time nullable
generation_datestring date-time nullable
errorstring nullable
convert_to_pdfboolean
language'en' | 'pt' | 'de' | 'fr' | 'es'

Language a document is rendered in.

Members are ISO 639-1 codes. This docstring is served as the field description in the public OpenAPI spec, so keep it about the contract; the reasoning behind the closed set is on :attr:~phoenix.db.models.document.Document.language and in revision a3f8d2c15e47.

The values are what documents.language stores (a native PostgreSQL enum of member values, unlike document_type above -- NULL there for the CSV exports, which render no text) and what the report-generation microservice takes on the wire, where they must match its own Language enum label for label — it ships translations for exactly these five and answers anything else with English, so a member added here without one there is silently wrong rather than an error.

createdstring date-time nullable
event_slugstring nullable required

Previous name for pentest_slug.

Changes

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