Skip to content
Trusty Sweep Developers

An export package is ready for download

POST

Delivered as a CloudEvents 1.0 envelope whose data is a Job. Batched ≤ 20 per delivery as a JSON array; signed with Sweep-Signature.

Request Body

Section titled “Request Body”
Media typeapplication/json
Array
object
specversion
required
string
Allowed values: 1.0
id
required

Prefixed ULID (evt_…)

string
/^evt_[0-9A-HJKMNP-TV-Z]{26}$/
source
required

Https://api.trustysweep.com

string
type
required

Event type from events.json, e.g. sweep.execution.completed

string
time
required
string format: date-time
subject

Primary resource id

string
datacontenttype
string
Allowed values: application/json
data
required
object
key
additional properties
sweepsimulated

CloudEvents extension: true in developer test mode.

boolean
type
required
Allowed value: sweep.export.ready
data
required
object
id
required

Prefixed ULID (job_…)

string
/^job_[0-9A-HJKMNP-TV-Z]{26}$/
kind
required
string
Allowed values: scan export reconcile index migration deletion seed
status
required
string
Allowed values: queued running succeeded failed cancelled
progress
required
integer
<= 100
result
One of:
error
One of:
string
created_at
required
string format: date-time
updated_at
required
string format: date-time
finished_at
One of:
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Acknowledge with any 2xx within 10 seconds