Skip to main content
POST
Start a conformance run against an owned connection

Authorizations

Authorization
string
header
required

A cdojo_... API key created in the app under Settings.

Headers

Idempotency-Key
string

One key per start. A retry with the same key and body answers 202 with the original run once it is queued, ignoring wait; the same key with a different body answers 409. A key names its run for 24 hours, then starts a new one.

Required string length: 1 - 128

Query Parameters

wait
integer

Seconds to long-poll before answering. Values above 55 are clamped to 55. Omit to answer immediately.

Required range: 1 <= x <= 55

Body

application/json
connectionId
string
required
module
string
seed
string

Makes the run repeatable: the ids it creates on your endpoint are derived from this, so another run of this connection and these modules with the same seed sends the same requests, apart from the differences listed at https://docs.chargerdojo.com/guide/run-a-suite#repeat-a-run. Omit it and one is generated and returned; with replayOf, the replayed run's seed is used instead.

Required string length: 1 - 128
replayOf
string

The reportId of an earlier graded run this run replays. It must be a run of the same connectionId and module, or the start is refused with 400 naming the field; an unknown id, or one from another account, answers 404. Omit seed to repeat that run's requests with its seed.

Response

Success

success
boolean
required
data
object
required
meta
object

Paging, on the operations that return a list.