Skip to main content
POST
Run a dataset against a registered HTTP Target

Authorizations

x-api-key
string
header
required

Project API key. Manage keys in the Zespan dashboard under project settings.

Path Parameters

datasetId
string<uuid>
required

Dataset id.

Body

application/json
httpTargetId
string<uuid>
required

Id of a registered HTTP Target in this project.

runName
string

Optional run name. Reusing an existing run's name re-attaches to it instead of creating a duplicate. Defaults to an auto-generated http-target-<id> name.

Required string length: 1 - 120
projectId
string<uuid>

Optional when authenticating with an API key.

Response

Run created and execution enqueued (or created but not enqueued — see note).

runId
string<uuid>
name
string
status
string
Example:

"queued"

total
integer

Number of dataset items this run will process.

note
string

Present only when the execution queue was unavailable — the run was created but not enqueued.