Entity Ingestion Config API
Update Entity Ingestion Config
Update an entity ingestion config. Supports partial updates — only provided fields are changed.
PATCH
/
v2
/
entity-ingestion-configs
/
{config_id}
Update Entity Ingestion Config
curl --request PATCH \
--url https://public.api.serval.com/v2/entity-ingestion-configs/{config_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workflowId": "<string>",
"enabled": true,
"syncDeletions": true,
"syncIntervalSeconds": "<unknown>"
}
'import requests
url = "https://public.api.serval.com/v2/entity-ingestion-configs/{config_id}"
payload = {
"workflowId": "<string>",
"enabled": True,
"syncDeletions": True,
"syncIntervalSeconds": "<unknown>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflowId: '<string>',
enabled: true,
syncDeletions: true,
syncIntervalSeconds: '<unknown>'
})
};
fetch('https://public.api.serval.com/v2/entity-ingestion-configs/{config_id}', 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://public.api.serval.com/v2/entity-ingestion-configs/{config_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'workflowId' => '<string>',
'enabled' => true,
'syncDeletions' => true,
'syncIntervalSeconds' => '<unknown>'
]),
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://public.api.serval.com/v2/entity-ingestion-configs/{config_id}"
payload := strings.NewReader("{\n \"workflowId\": \"<string>\",\n \"enabled\": true,\n \"syncDeletions\": true,\n \"syncIntervalSeconds\": \"<unknown>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://public.api.serval.com/v2/entity-ingestion-configs/{config_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workflowId\": \"<string>\",\n \"enabled\": true,\n \"syncDeletions\": true,\n \"syncIntervalSeconds\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/entity-ingestion-configs/{config_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflowId\": \"<string>\",\n \"enabled\": true,\n \"syncDeletions\": true,\n \"syncIntervalSeconds\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"appInstanceId": "<string>",
"workflowId": "<string>",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"teamId": "<string>",
"serviceName": "<string>",
"workflowName": "<string>",
"isWorkflowPublished": true,
"hasIngestionContext": true,
"syncDeletions": true,
"internalEntityTypeId": "<string>",
"syncIntervalSeconds": "<unknown>"
}
}{
"message": "<string>",
"detail": {
"type": "<string>",
"value": "<string>",
"debug": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the ingestion config.
Body
application/json
The ID of the workflow that performs the entity sync.
Whether the ingestion config is enabled.
Whether to sync deletions from external source.
Minimum interval between scheduled syncs, in seconds. Absent leaves the current setting unchanged; 0 resets to "auto" (platform default cadence); any positive value sets that interval.
Response
Success
The updated ingestion config.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update Entity Ingestion Config
curl --request PATCH \
--url https://public.api.serval.com/v2/entity-ingestion-configs/{config_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workflowId": "<string>",
"enabled": true,
"syncDeletions": true,
"syncIntervalSeconds": "<unknown>"
}
'import requests
url = "https://public.api.serval.com/v2/entity-ingestion-configs/{config_id}"
payload = {
"workflowId": "<string>",
"enabled": True,
"syncDeletions": True,
"syncIntervalSeconds": "<unknown>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflowId: '<string>',
enabled: true,
syncDeletions: true,
syncIntervalSeconds: '<unknown>'
})
};
fetch('https://public.api.serval.com/v2/entity-ingestion-configs/{config_id}', 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://public.api.serval.com/v2/entity-ingestion-configs/{config_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'workflowId' => '<string>',
'enabled' => true,
'syncDeletions' => true,
'syncIntervalSeconds' => '<unknown>'
]),
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://public.api.serval.com/v2/entity-ingestion-configs/{config_id}"
payload := strings.NewReader("{\n \"workflowId\": \"<string>\",\n \"enabled\": true,\n \"syncDeletions\": true,\n \"syncIntervalSeconds\": \"<unknown>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://public.api.serval.com/v2/entity-ingestion-configs/{config_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workflowId\": \"<string>\",\n \"enabled\": true,\n \"syncDeletions\": true,\n \"syncIntervalSeconds\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/entity-ingestion-configs/{config_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflowId\": \"<string>\",\n \"enabled\": true,\n \"syncDeletions\": true,\n \"syncIntervalSeconds\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"appInstanceId": "<string>",
"workflowId": "<string>",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"teamId": "<string>",
"serviceName": "<string>",
"workflowName": "<string>",
"isWorkflowPublished": true,
"hasIngestionContext": true,
"syncDeletions": true,
"internalEntityTypeId": "<string>",
"syncIntervalSeconds": "<unknown>"
}
}{
"message": "<string>",
"detail": {
"type": "<string>",
"value": "<string>",
"debug": {}
}
}
