Assessments

Complete an assessment

Finishes the assessment. completed and partial resolve the findings this assessment's coverage examined (outcome completed, and nothing failed or skipped for the same thing) that it did not see; failed and cancelled resolve nothing. Completing again with the same status answers the assessment; with another, 409.

post/v1/assessments/{assessmentId}/complete

Request

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

Request body

protocol_version1 required
reasonstring
status'completed' | 'partial' | 'failed' | 'cancelled' required

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.