Seed the application's isolated test tenant with synthetic sources

POST

/v1/developer/applications/{id}/test-mode/seed

const url = 'https://api.trustysweep.com/v1/developer/applications/example/test-mode/seed';
const options = {
  method: 'POST',
  headers: {
    cookie: 'sweep_session=<sweep_session>',
    'Content-Type': 'application/json'
  },
  body: '{"scenario":"storage_pressure","seed":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.trustysweep.com/v1/developer/applications/example/test-mode/seed \
  --header 'Content-Type: application/json' \
  --cookie sweep_session=<sweep_session> \
  --data '{ "scenario": "storage_pressure", "seed": "example" }'

Authorizations

sessionCookie
sessionToken
apiKey
sources:write
oauth2
sources:write

Parameters

Path Parameters

required

string

/^app_[0-9A-HJKMNP-TV-Z]{26}$/

Header Parameters

Idempotency-Key

string

<= 255 characters

Unique key per logical operation. Same key + same body within 24h replays the original response with Idempotent-Replayed: true; same key + different body → 409 idempotency_key_reused.

Request Body

application/json

object

scenario

string

default: storage_pressure

Allowed values: storage_pressure trials_and_meters creator_revenue clean

seed

string

<= 64 characters

Responses

201

Created

application/json

object

connection

required

object

required

Prefixed ULID (cxn_…)

string

/^cxn_[0-9A-HJKMNP-TV-Z]{26}$/

application_id

required

Prefixed ULID (app_…)

string

/^app_[0-9A-HJKMNP-TV-Z]{26}$/

end_user_ref

required

string

principal_id

required

string

grant_id

required

Prefixed ULID (grt_…)

string

/^grt_[0-9A-HJKMNP-TV-Z]{26}$/

operations

required

Array<string>

Allowed values: discover preserve write remove restore migrate monitor automate billable_execute

status

required

string

Allowed values: active revoked

source_ids

required

Array<string>

simulated

required

boolean

created_at

required

string format: date-time

revoked_at

One of:

string
null

string format: date-time

sources

required

Array<object>

object

required

Prefixed ULID (src_…)

string

/^src_[0-9A-HJKMNP-TV-Z]{26}$/

provider

required

string

Allowed values: google_gmail google_drive microsoft_outlook microsoft_onedrive dropbox apple_local s3_compatible trusty_vault simulated

kind

required

string

external_account_id

required

string

display_name

required

string

email

One of:

string
null

string

status

required

string

Allowed values: connected reauth_required revoked disconnected error pending

granted_scopes

Array<string>

granted_operations

required

Array<string>

Allowed values: discover preserve write remove restore migrate monitor automate billable_execute

connected_at

required

string format: date-time

last_scan_at

One of:

string
null

string format: date-time

last_delta_marker

One of:

string
null

string

connected_via_application_id

One of:

string
null

Prefixed ULID (app_…)

string

/^app_[0-9A-HJKMNP-TV-Z]{26}$/

connection_id

One of:

string
null

Prefixed ULID (cxn_…)

string

/^cxn_[0-9A-HJKMNP-TV-Z]{26}$/

simulated

required

boolean

policy

object

version

string

minAgeDays

integer

minSizeBytes

integer

excludeSenders

Array<string>

excludeDomains

Array<string>

excludeLabels

Array<string>

excludeFolders

Array<string>

excludeStarred

boolean

excludeShared

boolean

excludeRecentDays

integer

preserveMimeTypes

Array<string>

preserveKeywords

Array<string>

removePromotional

boolean

duplicateHandling

string

Allowed values: keep_newest keep_oldest review

sourceAction

string

Allowed values: trash none

preservation

string

Allowed values: vault_all vault_preserve_class_only

quota

One of:

object
null

object

used_bytes

required

integer

limit_bytes

required

One of:

integer
null

integer

trash_bytes

integer

breakdown

object

key

additional properties

integer

observed_at

required

string format: date-time

growth_bytes_per_day

One of:

number
null

number

projected_full_at

One of:

string
null

string format: date-time

job

required

object

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:

unknown
null

error

One of:

string
null

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

finished_at

One of:

string
null

string format: date-time

Example

{
  "connection": {
    "id": "cxn_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
    "application_id": "app_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
    "grant_id": "grt_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
    "operations": [
      "discover"
    ],
    "status": "active",
    "source_ids": [
      "src_01J8Z3K9M2Q4R6S8T0V2W4X6Y8"
    ]
  },
  "sources": [
    {
      "id": "src_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
      "provider": "google_gmail",
      "status": "connected",
      "granted_operations": [
        "discover"
      ],
      "connected_via_application_id": "app_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
      "connection_id": "cxn_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
      "policy": {
        "duplicateHandling": "keep_newest",
        "sourceAction": "trash",
        "preservation": "vault_all"
      }
    }
  ],
  "job": {
    "id": "job_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
    "kind": "scan",
    "status": "queued"
  }
}

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

Validation failed

application/problem+json

RFC 9457 problem details.

object

type

required

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

string format: uri

titlerequired

string

statusrequired

integer

detail

string

coderequired

Machine-readable error code from errors.json

string

request_idrequired

string

errors

Array<object>

object

pathrequired

string

messagerequired

string

`Example^generated`

{
  "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
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "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
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "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
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`409`

Section titled “409”

Conflict (state, stale plan, idempotency key reuse)

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "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
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "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
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

Seed the application's isolated test tenant with synthetic sources

Authorizations

Parameters

Path Parameters

Header Parameters

Request Body

Responses

201

Example

Headers

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

Headers

500

Examplegenerated

`Example^generated`

`401`

`Example^generated`

`403`

`Example^generated`

`404`

`Example^generated`

`409`

`Example^generated`

`429`

`Example^generated`

`Headers`

`500`

`Example^generated`