Trigger a schedule

Starts the schedule now, like Run now in the app. The response is 204 No Content and does not include the new test run's ID.

To follow the run you start, for example in a CI pipeline, use POST /v2/schedules/test-runs/{id}/run or POST /v2/schedules/test-runs instead:
both return the new run. Do not assume that the newest run in the list is
yours, because other runs can start at the same time.

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

Reusable schedule/run-configuration ID, not a scheduler ID.

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
204

Trigger endpoint completed; response has no body or test-run ID.

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…