Assessments

Get an assessment

Where it is, what it received, and what it did to findings (observed, new, reopened, resolved).

get/v1/assessments/{assessmentId}

Request

  • Base URL: https://api.ironfang.com/security
  • URL: https://api.ironfang.com/security/v1/assessments/{assessmentId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Response

The assessment.

batches_receivedinteger required
client_referencestring
completed_atstring date-time
created_atstring date-time required
expires_atstring date-time

While open, when it fails if not completed.

idstring uuid required
protocol_versioninteger required
results_receivedinteger required
scan_idstring uuid

The External Security Check this assessment is.

started_atstring date-time
status'queued' | 'running' | 'completed' | 'partial' | 'failed' | 'cancelled' required
status_reasonstring

Changes

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