Skip to content
Trusty Sweep Developers

Get an execution

GET
/v1/executions/{id}
curl --request GET \
  --url https://api.trustysweep.com/v1/executions/example \
  --cookie sweep_session=<sweep_session>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
/^exe_[0-9A-HJKMNP-TV-Z]{26}$/

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
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
Example
{
  "id": "exe_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "plan_id": "pln_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "status": "queued",
  "receipt_id": "rcp_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "steps": [
    {
      "asset_id": "ast_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
      "from_state": "DISCOVERED",
      "to_state": "DISCOVERED"
    }
  ]
}

Headers

Section titled “Headers”
RateLimit-Limit
integer

Requests allowed in the current window.

RateLimit-Remaining
integer

Requests remaining in the current window.

RateLimit-Reset
integer

Seconds until the window resets.

400

Section titled “400”

Validation failed

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required

Https://developers.trustysweep.com/errors/

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

401

Section titled “401”

Unauthenticated

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required

Https://developers.trustysweep.com/errors/

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

403

Section titled “403”

Forbidden / action denied / step-up required

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required

Https://developers.trustysweep.com/errors/

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

404

Section titled “404”

Not found

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required

Https://developers.trustysweep.com/errors/

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

429

Section titled “429”

Rate limited

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required

Https://developers.trustysweep.com/errors/

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.

RateLimit-Limit
integer

Requests allowed in the current window.

RateLimit-Remaining
integer

Requests remaining in the current window.

RateLimit-Reset
integer

Seconds until the window resets.

500

Section titled “500”

Internal error

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required

Https://developers.trustysweep.com/errors/

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}