Skip to content
Trusty Sweep Developers

Revalidate preconditions against current provider state

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Header Parameters

Section titled “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.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
ok
required
boolean
stale
required
boolean
expired
required
boolean
material_change
required
boolean
drifted_objects
required
Array<object>
object
assetId
required
string
reason
required
string
Allowed values: missing version_changed size_changed hash_changed already_trashed
drifted_sources
required
Array<object>
object
sourceId
required
string
expected
required
string
observed
required
string
plan_state
required
string
Allowed values: draft validated authorized committing committed executed partially_executed stale expired rejected cancelled
Example
{
  "drifted_objects": [
    {
      "reason": "missing"
    }
  ],
  "plan_state": "draft"
}

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"
    }
  ]
}

409

Section titled “409”

Conflict (state, stale plan, idempotency key reuse)

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"
    }
  ]
}