Skip to main content
Initialize cloud sync
curl --request POST \
  --url https://api.example.com/sync/init \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "<string>",
  "password": "<string>",
  "machine_id": "<string>",
  "sync_interval_secs": 123
}
'
import requests

url = "https://api.example.com/sync/init"

payload = {
"token": "<string>",
"password": "<string>",
"machine_id": "<string>",
"sync_interval_secs": 123
}
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({
token: '<string>',
password: '<string>',
machine_id: '<string>',
sync_interval_secs: 123
})
};

fetch('https://api.example.com/sync/init', 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/sync/init",
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([
'token' => '<string>',
'password' => '<string>',
'machine_id' => '<string>',
'sync_interval_secs' => 123
]),
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/sync/init"

payload := strings.NewReader("{\n \"token\": \"<string>\",\n \"password\": \"<string>\",\n \"machine_id\": \"<string>\",\n \"sync_interval_secs\": 123\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/sync/init")
.header("Content-Type", "application/json")
.body("{\n \"token\": \"<string>\",\n \"password\": \"<string>\",\n \"machine_id\": \"<string>\",\n \"sync_interval_secs\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/sync/init")

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 \"token\": \"<string>\",\n \"password\": \"<string>\",\n \"machine_id\": \"<string>\",\n \"sync_interval_secs\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "is_new_user": true,
  "machine_id": "<string>"
}

Body

application/json

Request to initialize sync at runtime.

token
string
required
password
string
required
machine_id
string | null
required
sync_interval_secs
integer | null
required

Response

200 - application/json

OK

Response from sync initialization.

success
boolean
required
is_new_user
boolean
required
machine_id
string
required