Workflows
Dry-run a workflow
Validates a workflow execution without creating actual runs.
POST
/
v1
/
workflows
/
{workflowID}
/
dry-run
Dry-run a workflow
curl --request POST \
--url https://api.strait.dev/v1/workflows/{workflowID}/dry-run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"steps": [
{
"step_ref": "<string>",
"approval_approvers": [
"<string>"
],
"approval_timeout_secs": 123,
"compensation_job_id": "<string>",
"compensation_timeout_secs": 123,
"concurrency_key": "<string>",
"condition": "<unknown>",
"depends_on": [
"<string>"
],
"event_emit_key": "<string>",
"event_key": "<string>",
"event_notify_url": "<string>",
"event_timeout_secs": 123,
"expected_duration_secs": 123,
"job_id": "<string>",
"max_nesting_depth": 123,
"on_failure": "<string>",
"output_transform": "<string>",
"payload": "<unknown>",
"resource_class": "<string>",
"retry_backoff": "<string>",
"retry_initial_delay_secs": 123,
"retry_max_attempts": 123,
"retry_max_delay_secs": 123,
"sleep_duration_secs": 123,
"stage_notifications": "<unknown>",
"step_type": "<string>",
"sub_workflow_id": "<string>",
"timeout_secs_override": 123
}
]
}
'import requests
url = "https://api.strait.dev/v1/workflows/{workflowID}/dry-run"
payload = { "steps": [
{
"step_ref": "<string>",
"approval_approvers": ["<string>"],
"approval_timeout_secs": 123,
"compensation_job_id": "<string>",
"compensation_timeout_secs": 123,
"concurrency_key": "<string>",
"condition": "<unknown>",
"depends_on": ["<string>"],
"event_emit_key": "<string>",
"event_key": "<string>",
"event_notify_url": "<string>",
"event_timeout_secs": 123,
"expected_duration_secs": 123,
"job_id": "<string>",
"max_nesting_depth": 123,
"on_failure": "<string>",
"output_transform": "<string>",
"payload": "<unknown>",
"resource_class": "<string>",
"retry_backoff": "<string>",
"retry_initial_delay_secs": 123,
"retry_max_attempts": 123,
"retry_max_delay_secs": 123,
"sleep_duration_secs": 123,
"stage_notifications": "<unknown>",
"step_type": "<string>",
"sub_workflow_id": "<string>",
"timeout_secs_override": 123
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
steps: [
{
step_ref: '<string>',
approval_approvers: ['<string>'],
approval_timeout_secs: 123,
compensation_job_id: '<string>',
compensation_timeout_secs: 123,
concurrency_key: '<string>',
condition: '<unknown>',
depends_on: ['<string>'],
event_emit_key: '<string>',
event_key: '<string>',
event_notify_url: '<string>',
event_timeout_secs: 123,
expected_duration_secs: 123,
job_id: '<string>',
max_nesting_depth: 123,
on_failure: '<string>',
output_transform: '<string>',
payload: '<unknown>',
resource_class: '<string>',
retry_backoff: '<string>',
retry_initial_delay_secs: 123,
retry_max_attempts: 123,
retry_max_delay_secs: 123,
sleep_duration_secs: 123,
stage_notifications: '<unknown>',
step_type: '<string>',
sub_workflow_id: '<string>',
timeout_secs_override: 123
}
]
})
};
fetch('https://api.strait.dev/v1/workflows/{workflowID}/dry-run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.strait.dev/v1/workflows/{workflowID}/dry-run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'steps' => [
[
'step_ref' => '<string>',
'approval_approvers' => [
'<string>'
],
'approval_timeout_secs' => 123,
'compensation_job_id' => '<string>',
'compensation_timeout_secs' => 123,
'concurrency_key' => '<string>',
'condition' => '<unknown>',
'depends_on' => [
'<string>'
],
'event_emit_key' => '<string>',
'event_key' => '<string>',
'event_notify_url' => '<string>',
'event_timeout_secs' => 123,
'expected_duration_secs' => 123,
'job_id' => '<string>',
'max_nesting_depth' => 123,
'on_failure' => '<string>',
'output_transform' => '<string>',
'payload' => '<unknown>',
'resource_class' => '<string>',
'retry_backoff' => '<string>',
'retry_initial_delay_secs' => 123,
'retry_max_attempts' => 123,
'retry_max_delay_secs' => 123,
'sleep_duration_secs' => 123,
'stage_notifications' => '<unknown>',
'step_type' => '<string>',
'sub_workflow_id' => '<string>',
'timeout_secs_override' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.strait.dev/v1/workflows/{workflowID}/dry-run"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"step_ref\": \"<string>\",\n \"approval_approvers\": [\n \"<string>\"\n ],\n \"approval_timeout_secs\": 123,\n \"compensation_job_id\": \"<string>\",\n \"compensation_timeout_secs\": 123,\n \"concurrency_key\": \"<string>\",\n \"condition\": \"<unknown>\",\n \"depends_on\": [\n \"<string>\"\n ],\n \"event_emit_key\": \"<string>\",\n \"event_key\": \"<string>\",\n \"event_notify_url\": \"<string>\",\n \"event_timeout_secs\": 123,\n \"expected_duration_secs\": 123,\n \"job_id\": \"<string>\",\n \"max_nesting_depth\": 123,\n \"on_failure\": \"<string>\",\n \"output_transform\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"resource_class\": \"<string>\",\n \"retry_backoff\": \"<string>\",\n \"retry_initial_delay_secs\": 123,\n \"retry_max_attempts\": 123,\n \"retry_max_delay_secs\": 123,\n \"sleep_duration_secs\": 123,\n \"stage_notifications\": \"<unknown>\",\n \"step_type\": \"<string>\",\n \"sub_workflow_id\": \"<string>\",\n \"timeout_secs_override\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.strait.dev/v1/workflows/{workflowID}/dry-run")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"steps\": [\n {\n \"step_ref\": \"<string>\",\n \"approval_approvers\": [\n \"<string>\"\n ],\n \"approval_timeout_secs\": 123,\n \"compensation_job_id\": \"<string>\",\n \"compensation_timeout_secs\": 123,\n \"concurrency_key\": \"<string>\",\n \"condition\": \"<unknown>\",\n \"depends_on\": [\n \"<string>\"\n ],\n \"event_emit_key\": \"<string>\",\n \"event_key\": \"<string>\",\n \"event_notify_url\": \"<string>\",\n \"event_timeout_secs\": 123,\n \"expected_duration_secs\": 123,\n \"job_id\": \"<string>\",\n \"max_nesting_depth\": 123,\n \"on_failure\": \"<string>\",\n \"output_transform\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"resource_class\": \"<string>\",\n \"retry_backoff\": \"<string>\",\n \"retry_initial_delay_secs\": 123,\n \"retry_max_attempts\": 123,\n \"retry_max_delay_secs\": 123,\n \"sleep_duration_secs\": 123,\n \"stage_notifications\": \"<unknown>\",\n \"step_type\": \"<string>\",\n \"sub_workflow_id\": \"<string>\",\n \"timeout_secs_override\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.strait.dev/v1/workflows/{workflowID}/dry-run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"steps\": [\n {\n \"step_ref\": \"<string>\",\n \"approval_approvers\": [\n \"<string>\"\n ],\n \"approval_timeout_secs\": 123,\n \"compensation_job_id\": \"<string>\",\n \"compensation_timeout_secs\": 123,\n \"concurrency_key\": \"<string>\",\n \"condition\": \"<unknown>\",\n \"depends_on\": [\n \"<string>\"\n ],\n \"event_emit_key\": \"<string>\",\n \"event_key\": \"<string>\",\n \"event_notify_url\": \"<string>\",\n \"event_timeout_secs\": 123,\n \"expected_duration_secs\": 123,\n \"job_id\": \"<string>\",\n \"max_nesting_depth\": 123,\n \"on_failure\": \"<string>\",\n \"output_transform\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"resource_class\": \"<string>\",\n \"retry_backoff\": \"<string>\",\n \"retry_initial_delay_secs\": 123,\n \"retry_max_attempts\": 123,\n \"retry_max_delay_secs\": 123,\n \"sleep_duration_secs\": 123,\n \"stage_notifications\": \"<unknown>\",\n \"step_type\": \"<string>\",\n \"sub_workflow_id\": \"<string>\",\n \"timeout_secs_override\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}⌘I
Dry-run a workflow
curl --request POST \
--url https://api.strait.dev/v1/workflows/{workflowID}/dry-run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"steps": [
{
"step_ref": "<string>",
"approval_approvers": [
"<string>"
],
"approval_timeout_secs": 123,
"compensation_job_id": "<string>",
"compensation_timeout_secs": 123,
"concurrency_key": "<string>",
"condition": "<unknown>",
"depends_on": [
"<string>"
],
"event_emit_key": "<string>",
"event_key": "<string>",
"event_notify_url": "<string>",
"event_timeout_secs": 123,
"expected_duration_secs": 123,
"job_id": "<string>",
"max_nesting_depth": 123,
"on_failure": "<string>",
"output_transform": "<string>",
"payload": "<unknown>",
"resource_class": "<string>",
"retry_backoff": "<string>",
"retry_initial_delay_secs": 123,
"retry_max_attempts": 123,
"retry_max_delay_secs": 123,
"sleep_duration_secs": 123,
"stage_notifications": "<unknown>",
"step_type": "<string>",
"sub_workflow_id": "<string>",
"timeout_secs_override": 123
}
]
}
'import requests
url = "https://api.strait.dev/v1/workflows/{workflowID}/dry-run"
payload = { "steps": [
{
"step_ref": "<string>",
"approval_approvers": ["<string>"],
"approval_timeout_secs": 123,
"compensation_job_id": "<string>",
"compensation_timeout_secs": 123,
"concurrency_key": "<string>",
"condition": "<unknown>",
"depends_on": ["<string>"],
"event_emit_key": "<string>",
"event_key": "<string>",
"event_notify_url": "<string>",
"event_timeout_secs": 123,
"expected_duration_secs": 123,
"job_id": "<string>",
"max_nesting_depth": 123,
"on_failure": "<string>",
"output_transform": "<string>",
"payload": "<unknown>",
"resource_class": "<string>",
"retry_backoff": "<string>",
"retry_initial_delay_secs": 123,
"retry_max_attempts": 123,
"retry_max_delay_secs": 123,
"sleep_duration_secs": 123,
"stage_notifications": "<unknown>",
"step_type": "<string>",
"sub_workflow_id": "<string>",
"timeout_secs_override": 123
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
steps: [
{
step_ref: '<string>',
approval_approvers: ['<string>'],
approval_timeout_secs: 123,
compensation_job_id: '<string>',
compensation_timeout_secs: 123,
concurrency_key: '<string>',
condition: '<unknown>',
depends_on: ['<string>'],
event_emit_key: '<string>',
event_key: '<string>',
event_notify_url: '<string>',
event_timeout_secs: 123,
expected_duration_secs: 123,
job_id: '<string>',
max_nesting_depth: 123,
on_failure: '<string>',
output_transform: '<string>',
payload: '<unknown>',
resource_class: '<string>',
retry_backoff: '<string>',
retry_initial_delay_secs: 123,
retry_max_attempts: 123,
retry_max_delay_secs: 123,
sleep_duration_secs: 123,
stage_notifications: '<unknown>',
step_type: '<string>',
sub_workflow_id: '<string>',
timeout_secs_override: 123
}
]
})
};
fetch('https://api.strait.dev/v1/workflows/{workflowID}/dry-run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.strait.dev/v1/workflows/{workflowID}/dry-run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'steps' => [
[
'step_ref' => '<string>',
'approval_approvers' => [
'<string>'
],
'approval_timeout_secs' => 123,
'compensation_job_id' => '<string>',
'compensation_timeout_secs' => 123,
'concurrency_key' => '<string>',
'condition' => '<unknown>',
'depends_on' => [
'<string>'
],
'event_emit_key' => '<string>',
'event_key' => '<string>',
'event_notify_url' => '<string>',
'event_timeout_secs' => 123,
'expected_duration_secs' => 123,
'job_id' => '<string>',
'max_nesting_depth' => 123,
'on_failure' => '<string>',
'output_transform' => '<string>',
'payload' => '<unknown>',
'resource_class' => '<string>',
'retry_backoff' => '<string>',
'retry_initial_delay_secs' => 123,
'retry_max_attempts' => 123,
'retry_max_delay_secs' => 123,
'sleep_duration_secs' => 123,
'stage_notifications' => '<unknown>',
'step_type' => '<string>',
'sub_workflow_id' => '<string>',
'timeout_secs_override' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.strait.dev/v1/workflows/{workflowID}/dry-run"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"step_ref\": \"<string>\",\n \"approval_approvers\": [\n \"<string>\"\n ],\n \"approval_timeout_secs\": 123,\n \"compensation_job_id\": \"<string>\",\n \"compensation_timeout_secs\": 123,\n \"concurrency_key\": \"<string>\",\n \"condition\": \"<unknown>\",\n \"depends_on\": [\n \"<string>\"\n ],\n \"event_emit_key\": \"<string>\",\n \"event_key\": \"<string>\",\n \"event_notify_url\": \"<string>\",\n \"event_timeout_secs\": 123,\n \"expected_duration_secs\": 123,\n \"job_id\": \"<string>\",\n \"max_nesting_depth\": 123,\n \"on_failure\": \"<string>\",\n \"output_transform\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"resource_class\": \"<string>\",\n \"retry_backoff\": \"<string>\",\n \"retry_initial_delay_secs\": 123,\n \"retry_max_attempts\": 123,\n \"retry_max_delay_secs\": 123,\n \"sleep_duration_secs\": 123,\n \"stage_notifications\": \"<unknown>\",\n \"step_type\": \"<string>\",\n \"sub_workflow_id\": \"<string>\",\n \"timeout_secs_override\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.strait.dev/v1/workflows/{workflowID}/dry-run")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"steps\": [\n {\n \"step_ref\": \"<string>\",\n \"approval_approvers\": [\n \"<string>\"\n ],\n \"approval_timeout_secs\": 123,\n \"compensation_job_id\": \"<string>\",\n \"compensation_timeout_secs\": 123,\n \"concurrency_key\": \"<string>\",\n \"condition\": \"<unknown>\",\n \"depends_on\": [\n \"<string>\"\n ],\n \"event_emit_key\": \"<string>\",\n \"event_key\": \"<string>\",\n \"event_notify_url\": \"<string>\",\n \"event_timeout_secs\": 123,\n \"expected_duration_secs\": 123,\n \"job_id\": \"<string>\",\n \"max_nesting_depth\": 123,\n \"on_failure\": \"<string>\",\n \"output_transform\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"resource_class\": \"<string>\",\n \"retry_backoff\": \"<string>\",\n \"retry_initial_delay_secs\": 123,\n \"retry_max_attempts\": 123,\n \"retry_max_delay_secs\": 123,\n \"sleep_duration_secs\": 123,\n \"stage_notifications\": \"<unknown>\",\n \"step_type\": \"<string>\",\n \"sub_workflow_id\": \"<string>\",\n \"timeout_secs_override\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.strait.dev/v1/workflows/{workflowID}/dry-run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"steps\": [\n {\n \"step_ref\": \"<string>\",\n \"approval_approvers\": [\n \"<string>\"\n ],\n \"approval_timeout_secs\": 123,\n \"compensation_job_id\": \"<string>\",\n \"compensation_timeout_secs\": 123,\n \"concurrency_key\": \"<string>\",\n \"condition\": \"<unknown>\",\n \"depends_on\": [\n \"<string>\"\n ],\n \"event_emit_key\": \"<string>\",\n \"event_key\": \"<string>\",\n \"event_notify_url\": \"<string>\",\n \"event_timeout_secs\": 123,\n \"expected_duration_secs\": 123,\n \"job_id\": \"<string>\",\n \"max_nesting_depth\": 123,\n \"on_failure\": \"<string>\",\n \"output_transform\": \"<string>\",\n \"payload\": \"<unknown>\",\n \"resource_class\": \"<string>\",\n \"retry_backoff\": \"<string>\",\n \"retry_initial_delay_secs\": 123,\n \"retry_max_attempts\": 123,\n \"retry_max_delay_secs\": 123,\n \"sleep_duration_secs\": 123,\n \"stage_notifications\": \"<unknown>\",\n \"step_type\": \"<string>\",\n \"sub_workflow_id\": \"<string>\",\n \"timeout_secs_override\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}