curl --request POST \
--url https://developer.synq.io/api/entities/v2/checks/categories \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"categories": [
{
"entityId": "<string>",
"technical": "<string>",
"governance": "<string>",
"etag": "<string>"
}
],
"actor": {
"name": "<string>",
"email": {
"userEmail": "jsmith@example.com"
}
}
}
'import requests
url = "https://developer.synq.io/api/entities/v2/checks/categories"
payload = {
"categories": [
{
"entityId": "<string>",
"technical": "<string>",
"governance": "<string>",
"etag": "<string>"
}
],
"actor": {
"name": "<string>",
"email": { "userEmail": "jsmith@example.com" }
}
}
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({
categories: [
{
entityId: '<string>',
technical: '<string>',
governance: '<string>',
etag: '<string>'
}
],
actor: {name: '<string>', email: {userEmail: 'jsmith@example.com'}}
})
};
fetch('https://developer.synq.io/api/entities/v2/checks/categories', 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://developer.synq.io/api/entities/v2/checks/categories",
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([
'categories' => [
[
'entityId' => '<string>',
'technical' => '<string>',
'governance' => '<string>',
'etag' => '<string>'
]
],
'actor' => [
'name' => '<string>',
'email' => [
'userEmail' => 'jsmith@example.com'
]
]
]),
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://developer.synq.io/api/entities/v2/checks/categories"
payload := strings.NewReader("{\n \"categories\": [\n {\n \"entityId\": \"<string>\",\n \"technical\": \"<string>\",\n \"governance\": \"<string>\",\n \"etag\": \"<string>\"\n }\n ],\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n }\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://developer.synq.io/api/entities/v2/checks/categories")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"categories\": [\n {\n \"entityId\": \"<string>\",\n \"technical\": \"<string>\",\n \"governance\": \"<string>\",\n \"etag\": \"<string>\"\n }\n ],\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/v2/checks/categories")
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 \"categories\": [\n {\n \"entityId\": \"<string>\",\n \"technical\": \"<string>\",\n \"governance\": \"<string>\",\n \"etag\": \"<string>\"\n }\n ],\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"categories": [
{
"entityId": "<string>",
"technical": {
"category": "<string>",
"override": "<string>",
"ruleId": "<string>",
"ruleTitle": "<string>",
"computed": {
"category": "<string>",
"ruleId": "<string>",
"ruleTitle": "<string>"
}
},
"governance": {
"category": "<string>",
"override": "<string>",
"ruleId": "<string>",
"ruleTitle": "<string>",
"computed": {
"category": "<string>",
"ruleId": "<string>",
"ruleTitle": "<string>"
}
},
"check": {
"name": "<string>",
"fullName": [
"<string>"
],
"package": "<string>",
"kind": "<string>",
"isPlatformNative": true,
"description": "<string>",
"checkedEntityIds": [
"<string>"
],
"annotations": {}
},
"etag": "<string>",
"updatedBy": {
"name": "<string>",
"email": {
"userEmail": "jsmith@example.com"
}
},
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}UpsertCheckCategories
Set the category of one or more checks explicitly. An explicit category is authoritative for its check: it overrides both the producer-declared category and anything the categorisation rules compute, and it survives every later rule change.
Each dimension updates independently. A field that is omitted leaves that dimension as it is; a field set to the empty string clears the explicit category on that dimension, so the check falls back to its producer-declared or rule-computed value. Repeating the same request converges to the same state rather than accumulating changes.
curl --request POST \
--url https://developer.synq.io/api/entities/v2/checks/categories \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"categories": [
{
"entityId": "<string>",
"technical": "<string>",
"governance": "<string>",
"etag": "<string>"
}
],
"actor": {
"name": "<string>",
"email": {
"userEmail": "jsmith@example.com"
}
}
}
'import requests
url = "https://developer.synq.io/api/entities/v2/checks/categories"
payload = {
"categories": [
{
"entityId": "<string>",
"technical": "<string>",
"governance": "<string>",
"etag": "<string>"
}
],
"actor": {
"name": "<string>",
"email": { "userEmail": "jsmith@example.com" }
}
}
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({
categories: [
{
entityId: '<string>',
technical: '<string>',
governance: '<string>',
etag: '<string>'
}
],
actor: {name: '<string>', email: {userEmail: 'jsmith@example.com'}}
})
};
fetch('https://developer.synq.io/api/entities/v2/checks/categories', 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://developer.synq.io/api/entities/v2/checks/categories",
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([
'categories' => [
[
'entityId' => '<string>',
'technical' => '<string>',
'governance' => '<string>',
'etag' => '<string>'
]
],
'actor' => [
'name' => '<string>',
'email' => [
'userEmail' => 'jsmith@example.com'
]
]
]),
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://developer.synq.io/api/entities/v2/checks/categories"
payload := strings.NewReader("{\n \"categories\": [\n {\n \"entityId\": \"<string>\",\n \"technical\": \"<string>\",\n \"governance\": \"<string>\",\n \"etag\": \"<string>\"\n }\n ],\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n }\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://developer.synq.io/api/entities/v2/checks/categories")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"categories\": [\n {\n \"entityId\": \"<string>\",\n \"technical\": \"<string>\",\n \"governance\": \"<string>\",\n \"etag\": \"<string>\"\n }\n ],\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/v2/checks/categories")
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 \"categories\": [\n {\n \"entityId\": \"<string>\",\n \"technical\": \"<string>\",\n \"governance\": \"<string>\",\n \"etag\": \"<string>\"\n }\n ],\n \"actor\": {\n \"name\": \"<string>\",\n \"email\": {\n \"userEmail\": \"jsmith@example.com\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"categories": [
{
"entityId": "<string>",
"technical": {
"category": "<string>",
"override": "<string>",
"ruleId": "<string>",
"ruleTitle": "<string>",
"computed": {
"category": "<string>",
"ruleId": "<string>",
"ruleTitle": "<string>"
}
},
"governance": {
"category": "<string>",
"override": "<string>",
"ruleId": "<string>",
"ruleTitle": "<string>",
"computed": {
"category": "<string>",
"ruleId": "<string>",
"ruleTitle": "<string>"
}
},
"check": {
"name": "<string>",
"fullName": [
"<string>"
],
"package": "<string>",
"kind": "<string>",
"isPlatformNative": true,
"description": "<string>",
"checkedEntityIds": [
"<string>"
],
"annotations": {}
},
"etag": "<string>",
"updatedBy": {
"name": "<string>",
"email": {
"userEmail": "jsmith@example.com"
}
},
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The checks to categorise. Every entry must name a distinct check.
1 - 500 elementsShow child attributes
Show child attributes
Who is making the change, when the caller acts on someone's behalf — an agent, a bot, an automation. Recorded as the editor and shown back on reads. Omit it when the caller's own credentials already identify them.
- Actor
- Actor
- Actor
Show child attributes
Show child attributes
Response
Success
The resolved category state of each updated check, in request order.
Show child attributes
Show child attributes