Skip to main content
POST
/
api
/
orgs
/
{id}
/
kpis
/
{kpiId}
/
http-syncs
Create KPI HTTP sync draft
curl --request POST \
  --url https://atollhq.com/api/orgs/{id}/kpis/{kpiId}/http-syncs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "request_config": {
    "method": "GET",
    "url": "<string>",
    "headers": {
      "Accept": "application/json"
    },
    "jsonBody": null
  },
  "extraction_config": {
    "contentType": "json",
    "pointer": "<string>",
    "numeric": {
      "mode": "number"
    }
  },
  "freshness_config": {}
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

id identifier

​
kpiId
string
required

kpiId identifier

Body

application/json

Draft KPI HTTP sync config. Do not include secret values, query strings, request bodies, redirects, or third-party payloads.

GET/HTTPS/JSON-only sync draft. Destination host must already be exactly allowlisted. Do not include secret values, query strings, request bodies, redirects, or raw third-party payloads.

​
name
string
required
​
schedule
enum<string>
required
Available options:
hourly,
daily
​
request_config
object
required
​
extraction_config
object
required
​
freshness_config
object

Response

Successful response

The response is of type object.