Run a scheduled occurrence now

Starts one occurrence of a saved schedule now and returns the new test run.
Use the returned id to follow the run, cancel it, and get its results.

  • {id} is a scheduler ID from the schedule's schedulers[], not the
    schedule ID.
  • startTime is that scheduler's nextTime. It selects the occurrence; the
    run starts immediately. A time in the past is rejected.

Requires the TestRun:Create permission. If the request times out, check
the test-run list before you retry: the run may already exist.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Scheduler ID from the schedule's schedulers[].

Query Params
date-time
required

Non-past occurrence timestamp of that scheduler.

Headers
uuid

Account UUID. Optional; send it to select the account explicitly.

int64

Organization ID. Optional; send it to select the organization explicitly.

int64
required

Project ID. Required on every request; without it the request returns 400.

Responses

400

The request is invalid. No response-body schema is asserted.

401

Authentication is missing or invalid. No response-body schema is asserted.

403

The API key does not have permission for this project or resource, or the ID is of the wrong type.

404

The resource does not exist in this project.

default

Any other error.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json