Run a watch now
POST
/api/v1/watches/{watchId}/runs
const url = 'http://localhost:11044/api/v1/watches/example/runs';const options = { method: 'POST', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>', 'Content-Type': 'application/json'}, body: '{"idempotencyKey":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:11044/api/v1/watches/example/runs \ --header 'Content-Type: application/json' \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \ --data '{ "idempotencyKey": "example" }'Repeat calls with the same idempotencyKey return the original run instead of running again.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”watchId
required
string
The watch to run now
Request Body
Section titled “Request Body”Optional. An idempotencyKey (trimmed; blank counts as none) makes the call repeatable: a later call on the same watch with the same key returns the run that key first started instead of running the lens again. Without a body or key, every call is a new run
Media typeapplication/json
The optional body of POST /watches/{watchId}/runs.
object
idempotencyKey
The caller’s key for this request; a repeat with the same key for the same watch returns the original run instead of running again. Omitted or blank, every call runs
string
Example generated
{ "idempotencyKey": "example"}Responses
Section titled “Responses”OK
Media typeapplication/json
object
Example generated
{}