Skip to main content
POST
/
v1
/
workflows
/
{workflow_uuid}
/
test
Test Workflow
curl --request POST \
  --url https://api.example.com/v1/workflows/{workflow_uuid}/test \
  --header 'Content-Type: application/json' \
  --data '
{
  "indicator_type": "ip",
  "indicator_value": "1.2.3.4",
  "mock_http_responses": {},
  "live_http": false
}
'
import requests

url = "https://api.example.com/v1/workflows/{workflow_uuid}/test"

payload = {
"indicator_type": "ip",
"indicator_value": "1.2.3.4",
"mock_http_responses": {},
"live_http": False
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
indicator_type: 'ip',
indicator_value: '1.2.3.4',
mock_http_responses: {},
live_http: false
})
};

fetch('https://api.example.com/v1/workflows/{workflow_uuid}/test', 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.example.com/v1/workflows/{workflow_uuid}/test",
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([
'indicator_type' => 'ip',
'indicator_value' => '1.2.3.4',
'mock_http_responses' => [

],
'live_http' => false
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/workflows/{workflow_uuid}/test"

payload := strings.NewReader("{\n \"indicator_type\": \"ip\",\n \"indicator_value\": \"1.2.3.4\",\n \"mock_http_responses\": {},\n \"live_http\": false\n}")

req, _ := http.NewRequest("POST", url, payload)

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.example.com/v1/workflows/{workflow_uuid}/test")
.header("Content-Type", "application/json")
.body("{\n \"indicator_type\": \"ip\",\n \"indicator_value\": \"1.2.3.4\",\n \"mock_http_responses\": {},\n \"live_http\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/workflows/{workflow_uuid}/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"indicator_type\": \"ip\",\n \"indicator_value\": \"1.2.3.4\",\n \"mock_http_responses\": {},\n \"live_http\": false\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "success": true,
    "message": "<string>",
    "log_output": "<string>",
    "duration_ms": 123,
    "result_data": {}
  },
  "meta": {}
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Path Parameters

workflow_uuid
string<uuid>
required

Body

application/json

Request body for POST /v1/workflows/{uuid}/test.

indicator_type
string
default:ip
indicator_value
string
default:1.2.3.4
mock_http_responses
Mock Http Responses · object
live_http
boolean
default:false

Response

Successful Response

data
WorkflowTestResponse · object
required

Response for POST /v1/workflows/{uuid}/test.

meta
Meta · object