POST/v1/stop_run

Stop run

Stop a currently running project. This will halt all processing and mark the run as stopped. Behavior: If the run is already stopped or success, returns success with current status. If the run is in progress, stops all pending cells and marks the run as stopped. Stopped runs cannot be resumed

Riveter·Free

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "riveter",
  path: "/v1/stop_run",
  query: {
    "run_key": "example"
  }
});

console.log(output);

Query parameters

run_keyrequired

string

The run key (UUID) of the project run to stop

Response

status

string

message

string

run_key

string

finished_at

string

project_name

string

project_uuid

string

request_status

string