Run KPI HTTP sync now
curl --request POST \
--url https://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"write_snapshot": true,
"confirm": "write api_poll snapshot"
}
'import requests
url = "https://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now"
payload = {
"write_snapshot": True,
"confirm": "write api_poll snapshot"
}
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({write_snapshot: true, confirm: 'write api_poll snapshot'})
};
fetch('https://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now', 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://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now",
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([
'write_snapshot' => true,
'confirm' => 'write api_poll snapshot'
]),
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://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now"
payload := strings.NewReader("{\n \"write_snapshot\": true,\n \"confirm\": \"write api_poll snapshot\"\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://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"write_snapshot\": true,\n \"confirm\": \"write api_poll snapshot\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now")
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 \"write_snapshot\": true,\n \"confirm\": \"write api_poll snapshot\"\n}"
response = http.request(request)
puts response.read_body{
"mode": "preview",
"result": {
"ok": true,
"configHash": "<string>",
"httpStatus": 123,
"durationMs": 123,
"responseBytes": 123,
"extractedValue": 123,
"errorCode": "<string>"
},
"run": {}
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}Strategy
Run KPI HTTP sync now
Human-admin-only. Defaults to dry-run preview. Writing an api_poll snapshot requires { "write_snapshot": true, "confirm": "write api_poll snapshot" }.
POST
/
api
/
orgs
/
{id}
/
kpis
/
{kpiId}
/
http-syncs
/
{syncId}
/
run-now
Run KPI HTTP sync now
curl --request POST \
--url https://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"write_snapshot": true,
"confirm": "write api_poll snapshot"
}
'import requests
url = "https://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now"
payload = {
"write_snapshot": True,
"confirm": "write api_poll snapshot"
}
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({write_snapshot: true, confirm: 'write api_poll snapshot'})
};
fetch('https://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now', 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://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now",
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([
'write_snapshot' => true,
'confirm' => 'write api_poll snapshot'
]),
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://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now"
payload := strings.NewReader("{\n \"write_snapshot\": true,\n \"confirm\": \"write api_poll snapshot\"\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://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"write_snapshot\": true,\n \"confirm\": \"write api_poll snapshot\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs/{syncId}/run-now")
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 \"write_snapshot\": true,\n \"confirm\": \"write api_poll snapshot\"\n}"
response = http.request(request)
puts response.read_body{
"mode": "preview",
"result": {
"ok": true,
"configHash": "<string>",
"httpStatus": 123,
"durationMs": 123,
"responseBytes": 123,
"extractedValue": 123,
"errorCode": "<string>"
},
"run": {}
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}{
"error": "Unauthorized",
"code": "unauthorized"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
id identifier
kpiId identifier
syncId identifier
Body
application/json
Defaults to preview. Snapshot writes require explicit confirmation.
Defaults to dry-run preview. Writing an api_poll snapshot requires both write_snapshot true and the exact confirm string.
⌘I

