Skip to content
Trusty Sweep Developers

A migration finished

POST

Delivered as a CloudEvents 1.0 envelope whose data is a Execution. 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.migration.completed
data
required
object
id
required

Prefixed ULID (exe_…)

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

Prefixed ULID (pln_…)

string
/^pln_[0-9A-HJKMNP-TV-Z]{26}$/
plan_hash
required
string
principal_id
required
string
status
required
string
Allowed values: queued running completed partially_completed failed cancelled
attempted
required
integer
completed
required
integer
failed
required
integer
bytes_preserved
required
integer
bytes_removed
required
integer
bytes_transferred
required
integer
measured_reclaim_bytes
One of:
integer
errors
Array<string>
simulated
required
boolean
receipt_id
One of:

Prefixed ULID (rcp_…)

string
/^rcp_[0-9A-HJKMNP-TV-Z]{26}$/
started_at
One of:
string format: date-time
finished_at
One of:
string format: date-time
created_at
required
string format: date-time
updated_at
required
string format: date-time
steps
Array<object>
object
asset_id
required

Prefixed ULID (ast_…)

string
/^ast_[0-9A-HJKMNP-TV-Z]{26}$/
step
required
string
status
required
string
from_state
One of:
string
Allowed values: DISCOVERED SELECTED FETCHING VAULTING VERIFYING VAULT_COMMITTED SOURCE_ACTION_QUEUED SOURCE_TRASHED_OR_REMOVED RECLAIM_PENDING RECLAIM_CONFIRMED RESTORE_QUEUED RESTORED EXCLUDED SKIPPED FAILED
to_state
One of:
string
Allowed values: DISCOVERED SELECTED FETCHING VAULTING VERIFYING VAULT_COMMITTED SOURCE_ACTION_QUEUED SOURCE_TRASHED_OR_REMOVED RECLAIM_PENDING RECLAIM_CONFIRMED RESTORE_QUEUED RESTORED EXCLUDED SKIPPED FAILED
at
required
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Acknowledge with any 2xx within 10 seconds