Skip to content
Trusty Sweep Developers

An Auto-Rescue run completed

POST

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

Prefixed ULID (exe_…)

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

Prefixed ULID (src_…)

string
/^src_[0-9A-HJKMNP-TV-Z]{26}$/
kind
required
string
Allowed values: autopilot auto_rescue
plan_id
One of:

Prefixed ULID (pln_…)

string
/^pln_[0-9A-HJKMNP-TV-Z]{26}$/
execution_id
One of:

Prefixed ULID (exe_…)

string
/^exe_[0-9A-HJKMNP-TV-Z]{26}$/
outcome
required
string
Allowed values: rescued no_action_needed skipped_ceiling skipped_policy failed
bytes_preserved
required
integer
bytes_removed
required
integer
storage_percent_after
One of:
number
charge_cents
required
integer
remaining_allowance_cents
One of:
integer
at
required
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Acknowledge with any 2xx within 10 seconds