Update Check Settings
curl --request POST \
--url https://api.velt.dev/v2/agents/checks/settings/update \
--header 'Content-Type: application/json' \
--header 'x-velt-api-key: <x-velt-api-key>' \
--header 'x-velt-auth-token: <x-velt-auth-token>' \
--data '
{
"data": {
"organizationId": "<string>",
"documentId": "<string>",
"settings": {}
}
}
'import requests
url = "https://api.velt.dev/v2/agents/checks/settings/update"
payload = { "data": {
"organizationId": "<string>",
"documentId": "<string>",
"settings": {}
} }
headers = {
"x-velt-api-key": "<x-velt-api-key>",
"x-velt-auth-token": "<x-velt-auth-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-velt-api-key': '<x-velt-api-key>',
'x-velt-auth-token': '<x-velt-auth-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({data: {organizationId: '<string>', documentId: '<string>', settings: {}}})
};
fetch('https://api.velt.dev/v2/agents/checks/settings/update', 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.velt.dev/v2/agents/checks/settings/update",
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([
'data' => [
'organizationId' => '<string>',
'documentId' => '<string>',
'settings' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-velt-api-key: <x-velt-api-key>",
"x-velt-auth-token: <x-velt-auth-token>"
],
]);
$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.velt.dev/v2/agents/checks/settings/update"
payload := strings.NewReader("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"settings\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
req.Header.Add("x-velt-auth-token", "<x-velt-auth-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://api.velt.dev/v2/agents/checks/settings/update")
.header("x-velt-api-key", "<x-velt-api-key>")
.header("x-velt-auth-token", "<x-velt-auth-token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"settings\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.velt.dev/v2/agents/checks/settings/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"settings\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"result": {
"status": "success",
"message": "Check settings updated",
"data": {
"confidenceFloor": 50,
"hostFlags": { "weeklyDigest": true },
"owners": {},
"source": "mirror",
"updatedAt": 1761465600000
}
}
}
Checks
Update Check Settings
POST
/
v2
/
agents
/
checks
/
settings
/
update
Update Check Settings
curl --request POST \
--url https://api.velt.dev/v2/agents/checks/settings/update \
--header 'Content-Type: application/json' \
--header 'x-velt-api-key: <x-velt-api-key>' \
--header 'x-velt-auth-token: <x-velt-auth-token>' \
--data '
{
"data": {
"organizationId": "<string>",
"documentId": "<string>",
"settings": {}
}
}
'import requests
url = "https://api.velt.dev/v2/agents/checks/settings/update"
payload = { "data": {
"organizationId": "<string>",
"documentId": "<string>",
"settings": {}
} }
headers = {
"x-velt-api-key": "<x-velt-api-key>",
"x-velt-auth-token": "<x-velt-auth-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-velt-api-key': '<x-velt-api-key>',
'x-velt-auth-token': '<x-velt-auth-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({data: {organizationId: '<string>', documentId: '<string>', settings: {}}})
};
fetch('https://api.velt.dev/v2/agents/checks/settings/update', 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.velt.dev/v2/agents/checks/settings/update",
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([
'data' => [
'organizationId' => '<string>',
'documentId' => '<string>',
'settings' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-velt-api-key: <x-velt-api-key>",
"x-velt-auth-token: <x-velt-auth-token>"
],
]);
$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.velt.dev/v2/agents/checks/settings/update"
payload := strings.NewReader("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"settings\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
req.Header.Add("x-velt-auth-token", "<x-velt-auth-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://api.velt.dev/v2/agents/checks/settings/update")
.header("x-velt-api-key", "<x-velt-api-key>")
.header("x-velt-auth-token", "<x-velt-auth-token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"settings\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.velt.dev/v2/agents/checks/settings/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"settings\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"result": {
"status": "success",
"message": "Check settings updated",
"data": {
"confidenceFloor": 50,
"hostFlags": { "weeklyDigest": true },
"owners": {},
"source": "mirror",
"updatedAt": 1761465600000
}
}
}
Use this API to update a project’s checks settings: the confidence floor, your own flags and the default owners. A field set to
The schema uses
See Get Check Settings for the fields.
Errors:
null is cleared. A field left out is kept. The response is the settings the engine now applies, as Get Check Settings returns them.
Endpoint
POST https://api.velt.dev/v2/agents/checks/settings/update
Headers
string
required
Your API key.
string
required
Your Auth Token.
Body
Params
object
required
Show properties
Show properties
string
required
1 to 512 characters. The organization of the project.
string
required
1 to 512 characters. The document of the project.
object
required
The settings to change. Every key is optional;
null clears it.| Key | Type | Description |
|---|---|---|
confidenceFloor | number | null | 0 to 100. A finding under it writes no comment. Default: 50. |
hostFlags | object | null | Your own boolean flags, by name (1 to 120 characters). Stored and returned, never read by the engine. A flag set to null is removed; hostFlags: null removes them all. |
owners | object | null | { content?, design?, dev?, admin? }, each { userId, name?, email? } or null. The default owner of a check by its responsibility; admin is the fallback. An owner set to null is removed; owners: null removes them all. |
.strict(): unknown fields, in data, settings, owners or an owner, are rejected.
Example Requests
1. Raise the floor and set the dev owner
{
"data": {
"organizationId": "org_acme",
"documentId": "acme-marketing-site",
"settings": {
"confidenceFloor": 60,
"owners": {
"dev": {
"userId": "user_jordan",
"name": "Jordan Lee",
"email": "jordan@example.com"
}
}
}
}
}
2. Set a flag and clear the floor
{
"data": {
"organizationId": "org_acme",
"documentId": "acme-marketing-site",
"settings": {
"confidenceFloor": null,
"hostFlags": {
"weeklyDigest": true
}
}
}
}
Response
Success Response
{
"result": {
"status": "success",
"message": "Check settings updated",
"data": {
"confidenceFloor": 60,
"hostFlags": {},
"owners": {
"dev": {
"userId": "user_jordan",
"name": "Jordan Lee",
"email": "jordan@example.com"
}
},
"source": "mirror",
"updatedAt": 1761465600000
}
}
}
Failure Response
{
"error": {
"message": "ERROR_MESSAGE",
"status": "INVALID_ARGUMENT",
"details": {
"issues": [
{ "code": "too_big", "path": ["settings", "confidenceFloor"], "message": "Number must be less than or equal to 100" }
]
}
}
}
INVALID_ARGUMENT (a body outside the schema: a missing settings, a confidenceFloor outside 0..100, a flag that is not a boolean or null, an owner without userId, or an unknown field) / NOT_FOUND with CHECKS_WORKSPACE_NOT_FOUND (the workspace has no store database).
{
"result": {
"status": "success",
"message": "Check settings updated",
"data": {
"confidenceFloor": 50,
"hostFlags": { "weeklyDigest": true },
"owners": {},
"source": "mirror",
"updatedAt": 1761465600000
}
}
}
Was this page helpful?

