Create a new test run
curl --request POST \
--url https://api.example.com/api/uat/v1/test-runs \
--header 'Content-Type: application/json' \
--data '
{
"rule_version": "<string>",
"config_snapshot": {},
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"git_sha": "<string>",
"data_snapshot_id": "<string>"
}
'import requests
url = "https://api.example.com/api/uat/v1/test-runs"
payload = {
"rule_version": "<string>",
"config_snapshot": {},
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"git_sha": "<string>",
"data_snapshot_id": "<string>"
}
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({
rule_version: '<string>',
config_snapshot: {},
scan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
git_sha: '<string>',
data_snapshot_id: '<string>'
})
};
fetch('https://api.example.com/api/uat/v1/test-runs', 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/api/uat/v1/test-runs",
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([
'rule_version' => '<string>',
'config_snapshot' => [
],
'scan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'git_sha' => '<string>',
'data_snapshot_id' => '<string>'
]),
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/api/uat/v1/test-runs"
payload := strings.NewReader("{\n \"rule_version\": \"<string>\",\n \"config_snapshot\": {},\n \"scan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"git_sha\": \"<string>\",\n \"data_snapshot_id\": \"<string>\"\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/api/uat/v1/test-runs")
.header("Content-Type", "application/json")
.body("{\n \"rule_version\": \"<string>\",\n \"config_snapshot\": {},\n \"scan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"git_sha\": \"<string>\",\n \"data_snapshot_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/uat/v1/test-runs")
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 \"rule_version\": \"<string>\",\n \"config_snapshot\": {},\n \"scan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"git_sha\": \"<string>\",\n \"data_snapshot_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}UAT Testing
Create a new test run
Create a new UAT test run.
POST
/
api
/
uat
/
v1
/
test-runs
Create a new test run
curl --request POST \
--url https://api.example.com/api/uat/v1/test-runs \
--header 'Content-Type: application/json' \
--data '
{
"rule_version": "<string>",
"config_snapshot": {},
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"git_sha": "<string>",
"data_snapshot_id": "<string>"
}
'import requests
url = "https://api.example.com/api/uat/v1/test-runs"
payload = {
"rule_version": "<string>",
"config_snapshot": {},
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"git_sha": "<string>",
"data_snapshot_id": "<string>"
}
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({
rule_version: '<string>',
config_snapshot: {},
scan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
git_sha: '<string>',
data_snapshot_id: '<string>'
})
};
fetch('https://api.example.com/api/uat/v1/test-runs', 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/api/uat/v1/test-runs",
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([
'rule_version' => '<string>',
'config_snapshot' => [
],
'scan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'git_sha' => '<string>',
'data_snapshot_id' => '<string>'
]),
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/api/uat/v1/test-runs"
payload := strings.NewReader("{\n \"rule_version\": \"<string>\",\n \"config_snapshot\": {},\n \"scan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"git_sha\": \"<string>\",\n \"data_snapshot_id\": \"<string>\"\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/api/uat/v1/test-runs")
.header("Content-Type", "application/json")
.body("{\n \"rule_version\": \"<string>\",\n \"config_snapshot\": {},\n \"scan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"git_sha\": \"<string>\",\n \"data_snapshot_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/uat/v1/test-runs")
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 \"rule_version\": \"<string>\",\n \"config_snapshot\": {},\n \"scan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"git_sha\": \"<string>\",\n \"data_snapshot_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Request model for creating a test run.
Type of UAT test.
Available options:
live_validation, backtest_replay, ab_variant, regression Must contain 'version' key
Response
Successful Response
The response is of type Response Create Test Run Api Uat V1 Test Runs Post · object.