Assessments

Start an assessment

Starts one collection run by one producer against one asset. The asset is named by id, or by type and name (created, with its parents, when it does not exist). With a client_reference the call is idempotent: the same reference answers 200 with the same assessment. An assessment not completed within 24 hours fails and resolves nothing.

post/v1/assessments

Request

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

Request body

client_referencestring

The producer's id for this run; use a UUID.

protocol_version1 required
started_atstring date-time

Response

Already started with this client_reference.

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.