curl --request POST \
--url https://developer.synq.io/api/recon/v1/deployments/trigger \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"actor": {
"name": "<string>",
"email": {
"userEmail": "jsmith@example.com"
}
},
"deploymentId": "<string>",
"runBisection": true,
"executionTimeout": "<string>"
}
'import requests
url = "https://developer.synq.io/api/recon/v1/deployments/trigger"
payload = {
"actor": {
"name": "<string>",
"email": { "userEmail": "jsmith@example.com" }
},
"deploymentId": "<string>",
"runBisection": True,
"executionTimeout": "<string>"
}
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({
actor: {name: '<string>', email: {userEmail: 'jsmith@example.com'}},
deploymentId: '<string>',
runBisection: true,
executionTimeout: '<string>'
})
};
fetch('https://developer.synq.io/api/recon/v1/deployments/trigger', 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://developer.synq.io/api/recon/v1/deployments/trigger",
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([
'actor' => [
'name' => '<string>',
'email' => [
'userEmail' => 'jsmith@example.com'
]
],
'deploymentId' => '<string>',
'runBisection' => true,
'executionTimeout' => '<string>'
]),
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://developer.synq.io/api/recon/v1/deployments/trigger"
payload := strings.NewReader("{\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n },\n \"deploymentId\": \"<string>\",\n \"runBisection\": true,\n \"executionTimeout\": \"<string>\"\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://developer.synq.io/api/recon/v1/deployments/trigger")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n },\n \"deploymentId\": \"<string>\",\n \"runBisection\": true,\n \"executionTimeout\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/recon/v1/deployments/trigger")
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 \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n },\n \"deploymentId\": \"<string>\",\n \"runBisection\": true,\n \"executionTimeout\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deploymentId": "<string>",
"runId": "<string>",
"scheduledAt": "2023-01-15T01:30:15.01Z"
}TriggerDeployment
Trigger an on-demand execution of a promoted deployment. Enqueues a run
using the frozen suite snapshot and connection mappings stored on the
deployment row — execution uses platform integration credentials, not the
caller’s. Returns the freshly-allocated run_id so callers can poll
RunStateService for status.
Preconditions:
- Deployment must exist and be
active. - Deployment must have
triggerable_by_api = true(FAILED_PRECONDITION otherwise). - Deployment must not be paused (FAILED_PRECONDITION when
paused_untilis set and in the future).
curl --request POST \
--url https://developer.synq.io/api/recon/v1/deployments/trigger \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"actor": {
"name": "<string>",
"email": {
"userEmail": "jsmith@example.com"
}
},
"deploymentId": "<string>",
"runBisection": true,
"executionTimeout": "<string>"
}
'import requests
url = "https://developer.synq.io/api/recon/v1/deployments/trigger"
payload = {
"actor": {
"name": "<string>",
"email": { "userEmail": "jsmith@example.com" }
},
"deploymentId": "<string>",
"runBisection": True,
"executionTimeout": "<string>"
}
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({
actor: {name: '<string>', email: {userEmail: 'jsmith@example.com'}},
deploymentId: '<string>',
runBisection: true,
executionTimeout: '<string>'
})
};
fetch('https://developer.synq.io/api/recon/v1/deployments/trigger', 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://developer.synq.io/api/recon/v1/deployments/trigger",
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([
'actor' => [
'name' => '<string>',
'email' => [
'userEmail' => 'jsmith@example.com'
]
],
'deploymentId' => '<string>',
'runBisection' => true,
'executionTimeout' => '<string>'
]),
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://developer.synq.io/api/recon/v1/deployments/trigger"
payload := strings.NewReader("{\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n },\n \"deploymentId\": \"<string>\",\n \"runBisection\": true,\n \"executionTimeout\": \"<string>\"\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://developer.synq.io/api/recon/v1/deployments/trigger")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n },\n \"deploymentId\": \"<string>\",\n \"runBisection\": true,\n \"executionTimeout\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/recon/v1/deployments/trigger")
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 \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n },\n \"deploymentId\": \"<string>\",\n \"runBisection\": true,\n \"executionTimeout\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deploymentId": "<string>",
"runId": "<string>",
"scheduledAt": "2023-01-15T01:30:15.01Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
- TriggerDeploymentRequest
- TriggerDeploymentRequest
Actor triggering the run. Required.
- actor
- actor
- actor
Show child attributes
Show child attributes
Per-run override for the deployment's stored run_bisection setting. Unset (the default) inherits the deployment's value, so an on-demand run behaves like a scheduled one. Set false for a cheap quick-check-only run with no bisection drill-down.
Per-run override for the deployment's stored execution_timeout. Unset (the default) inherits the deployment's value. Set it to bound this one run to a shorter or longer wall-clock budget; the server clamps the effective value to a supported range.
Response
Success
Identity of the deployment that was triggered (canonical form even when
the request used suite_id).
Stable opaque identifier of the enqueued run. Pass this to RunStateService to track lifecycle.
When the run is scheduled to start. For TriggerDeployment this is ~now(); the worker will pick it up shortly.
"2023-01-15T01:30:15.01Z"
"2024-12-25T12:00:00Z"