scans

Rename a scan

Update a scan's label. Send {"label": null} to clear it. Omitted fields are left unchanged.

patch/api/v1/scans/{scan_id}

Request

  • Base URL: https://api.sytecheck.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.sytecheck.app/api/v1/scans/{scan_id}
  • Auth: HTTP bearer

Path parameters

scan_idinteger required

Request body

labelstring nullable

Response

Successful Response

idinteger required
urlstring required
labelstring nullable required
status'queued' | 'scanning' | 'summarizing' | 'complete' | 'failed' required
categories_requestedstring[] required
overall_scorenumber nullable required
error_messagestring nullable
webhook_urlstring nullable
quota_refunded_atstring date-time nullable
used_scan_creditboolean
created_atstring date-time required
completed_atstring date-time nullable required

Changes

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