Update Filter
PATCH
/
v1
/
guards
/
filters
/
{filter_id}
cURL
curl --request PATCH \
--url https://api.domesystems.ai/v1/guards/filters/{filter_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "<string>",
"filter_id": "<string>",
"name": "<string>",
"name_provided": true,
"description": "<string>",
"description_provided": true,
"config": {
"text": {
"components": [
{
"action": 123,
"matchers": [
{
"substring": {
"value": "<string>"
},
"ssn": {
"delimiters": [
123
]
},
"credit_card": {
"delimiters": [
123
],
"require_luhn": true,
"min_digits": 123,
"max_digits": 123
},
"phone": {
"delimiters": [
123
],
"group_sizes": [
123
],
"require_country_code": true,
"require_parens": true
},
"digits": {
"digits": 123,
"group_sizes": [
123
],
"delimiters": [
123
]
}
}
]
}
]
},
"json": {
"components": [
{
"field_actions": [
{
"field": "<string>",
"action": "<string>",
"reason": "<string>"
}
]
}
]
}
},
"config_provided": true
}
'import requests
url = "https://api.domesystems.ai/v1/guards/filters/{filter_id}"
payload = {
"workspace_id": "<string>",
"filter_id": "<string>",
"name": "<string>",
"name_provided": True,
"description": "<string>",
"description_provided": True,
"config": {
"text": { "components": [
{
"action": 123,
"matchers": [
{
"substring": { "value": "<string>" },
"ssn": { "delimiters": [123] },
"credit_card": {
"delimiters": [123],
"require_luhn": True,
"min_digits": 123,
"max_digits": 123
},
"phone": {
"delimiters": [123],
"group_sizes": [123],
"require_country_code": True,
"require_parens": True
},
"digits": {
"digits": 123,
"group_sizes": [123],
"delimiters": [123]
}
}
]
}
] },
"json": { "components": [{ "field_actions": [
{
"field": "<string>",
"action": "<string>",
"reason": "<string>"
}
] }] }
},
"config_provided": True
}
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({
workspace_id: '<string>',
filter_id: '<string>',
name: '<string>',
name_provided: true,
description: '<string>',
description_provided: true,
config: {
text: {
components: [
{
action: 123,
matchers: [
{
substring: {value: '<string>'},
ssn: {delimiters: [123]},
credit_card: {delimiters: [123], require_luhn: true, min_digits: 123, max_digits: 123},
phone: {
delimiters: [123],
group_sizes: [123],
require_country_code: true,
require_parens: true
},
digits: {digits: 123, group_sizes: [123], delimiters: [123]}
}
]
}
]
},
json: {
components: [{field_actions: [{field: '<string>', action: '<string>', reason: '<string>'}]}]
}
},
config_provided: true
})
};
fetch('https://api.domesystems.ai/v1/guards/filters/{filter_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://api.domesystems.ai/v1/guards/filters/{filter_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([
'workspace_id' => '<string>',
'filter_id' => '<string>',
'name' => '<string>',
'name_provided' => true,
'description' => '<string>',
'description_provided' => true,
'config' => [
'text' => [
'components' => [
[
'action' => 123,
'matchers' => [
[
'substring' => [
'value' => '<string>'
],
'ssn' => [
'delimiters' => [
123
]
],
'credit_card' => [
'delimiters' => [
123
],
'require_luhn' => true,
'min_digits' => 123,
'max_digits' => 123
],
'phone' => [
'delimiters' => [
123
],
'group_sizes' => [
123
],
'require_country_code' => true,
'require_parens' => true
],
'digits' => [
'digits' => 123,
'group_sizes' => [
123
],
'delimiters' => [
123
]
]
]
]
]
]
],
'json' => [
'components' => [
[
'field_actions' => [
[
'field' => '<string>',
'action' => '<string>',
'reason' => '<string>'
]
]
]
]
]
],
'config_provided' => true
]),
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://api.domesystems.ai/v1/guards/filters/{filter_id}"
payload := strings.NewReader("{\n \"workspace_id\": \"<string>\",\n \"filter_id\": \"<string>\",\n \"name\": \"<string>\",\n \"name_provided\": true,\n \"description\": \"<string>\",\n \"description_provided\": true,\n \"config\": {\n \"text\": {\n \"components\": [\n {\n \"action\": 123,\n \"matchers\": [\n {\n \"substring\": {\n \"value\": \"<string>\"\n },\n \"ssn\": {\n \"delimiters\": [\n 123\n ]\n },\n \"credit_card\": {\n \"delimiters\": [\n 123\n ],\n \"require_luhn\": true,\n \"min_digits\": 123,\n \"max_digits\": 123\n },\n \"phone\": {\n \"delimiters\": [\n 123\n ],\n \"group_sizes\": [\n 123\n ],\n \"require_country_code\": true,\n \"require_parens\": true\n },\n \"digits\": {\n \"digits\": 123,\n \"group_sizes\": [\n 123\n ],\n \"delimiters\": [\n 123\n ]\n }\n }\n ]\n }\n ]\n },\n \"json\": {\n \"components\": [\n {\n \"field_actions\": [\n {\n \"field\": \"<string>\",\n \"action\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n ]\n }\n },\n \"config_provided\": true\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://api.domesystems.ai/v1/guards/filters/{filter_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"<string>\",\n \"filter_id\": \"<string>\",\n \"name\": \"<string>\",\n \"name_provided\": true,\n \"description\": \"<string>\",\n \"description_provided\": true,\n \"config\": {\n \"text\": {\n \"components\": [\n {\n \"action\": 123,\n \"matchers\": [\n {\n \"substring\": {\n \"value\": \"<string>\"\n },\n \"ssn\": {\n \"delimiters\": [\n 123\n ]\n },\n \"credit_card\": {\n \"delimiters\": [\n 123\n ],\n \"require_luhn\": true,\n \"min_digits\": 123,\n \"max_digits\": 123\n },\n \"phone\": {\n \"delimiters\": [\n 123\n ],\n \"group_sizes\": [\n 123\n ],\n \"require_country_code\": true,\n \"require_parens\": true\n },\n \"digits\": {\n \"digits\": 123,\n \"group_sizes\": [\n 123\n ],\n \"delimiters\": [\n 123\n ]\n }\n }\n ]\n }\n ]\n },\n \"json\": {\n \"components\": [\n {\n \"field_actions\": [\n {\n \"field\": \"<string>\",\n \"action\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n ]\n }\n },\n \"config_provided\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.domesystems.ai/v1/guards/filters/{filter_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 \"workspace_id\": \"<string>\",\n \"filter_id\": \"<string>\",\n \"name\": \"<string>\",\n \"name_provided\": true,\n \"description\": \"<string>\",\n \"description_provided\": true,\n \"config\": {\n \"text\": {\n \"components\": [\n {\n \"action\": 123,\n \"matchers\": [\n {\n \"substring\": {\n \"value\": \"<string>\"\n },\n \"ssn\": {\n \"delimiters\": [\n 123\n ]\n },\n \"credit_card\": {\n \"delimiters\": [\n 123\n ],\n \"require_luhn\": true,\n \"min_digits\": 123,\n \"max_digits\": 123\n },\n \"phone\": {\n \"delimiters\": [\n 123\n ],\n \"group_sizes\": [\n 123\n ],\n \"require_country_code\": true,\n \"require_parens\": true\n },\n \"digits\": {\n \"digits\": 123,\n \"group_sizes\": [\n 123\n ],\n \"delimiters\": [\n 123\n ]\n }\n }\n ]\n }\n ]\n },\n \"json\": {\n \"components\": [\n {\n \"field_actions\": [\n {\n \"field\": \"<string>\",\n \"action\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n ]\n }\n },\n \"config_provided\": true\n}"
response = http.request(request)
puts response.read_body{
"filter": {
"id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"description": "<string>",
"config": {
"text": {
"components": [
{
"action": 123,
"matchers": [
{
"substring": {
"value": "<string>"
},
"ssn": {
"delimiters": [
123
]
},
"credit_card": {
"delimiters": [
123
],
"require_luhn": true,
"min_digits": 123,
"max_digits": 123
},
"phone": {
"delimiters": [
123
],
"group_sizes": [
123
],
"require_country_code": true,
"require_parens": true
},
"digits": {
"digits": 123,
"group_sizes": [
123
],
"delimiters": [
123
]
}
}
]
}
]
},
"json": {
"components": [
{
"field_actions": [
{
"field": "<string>",
"action": "<string>",
"reason": "<string>"
}
]
}
]
}
},
"version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"kind": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Metadata edits on the logical filter. The *_provided flags distinguish "leave unchanged" from "set to this value".
When config_provided, deploy a NEW active version carrying this config.
Show child attributes
Show child attributes
Response
200 - application/json
OK
Filter is the logical, workspace-scoped Filter entity: a stable id + mutable metadata (name, description), plus its ACTIVE version's config denormalized for the common "show me this filter" read. Version history is a separate FilterVersion list (ListFilterVersions). Editing deploys a new active version; assignments follow the active version.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl --request PATCH \
--url https://api.domesystems.ai/v1/guards/filters/{filter_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "<string>",
"filter_id": "<string>",
"name": "<string>",
"name_provided": true,
"description": "<string>",
"description_provided": true,
"config": {
"text": {
"components": [
{
"action": 123,
"matchers": [
{
"substring": {
"value": "<string>"
},
"ssn": {
"delimiters": [
123
]
},
"credit_card": {
"delimiters": [
123
],
"require_luhn": true,
"min_digits": 123,
"max_digits": 123
},
"phone": {
"delimiters": [
123
],
"group_sizes": [
123
],
"require_country_code": true,
"require_parens": true
},
"digits": {
"digits": 123,
"group_sizes": [
123
],
"delimiters": [
123
]
}
}
]
}
]
},
"json": {
"components": [
{
"field_actions": [
{
"field": "<string>",
"action": "<string>",
"reason": "<string>"
}
]
}
]
}
},
"config_provided": true
}
'import requests
url = "https://api.domesystems.ai/v1/guards/filters/{filter_id}"
payload = {
"workspace_id": "<string>",
"filter_id": "<string>",
"name": "<string>",
"name_provided": True,
"description": "<string>",
"description_provided": True,
"config": {
"text": { "components": [
{
"action": 123,
"matchers": [
{
"substring": { "value": "<string>" },
"ssn": { "delimiters": [123] },
"credit_card": {
"delimiters": [123],
"require_luhn": True,
"min_digits": 123,
"max_digits": 123
},
"phone": {
"delimiters": [123],
"group_sizes": [123],
"require_country_code": True,
"require_parens": True
},
"digits": {
"digits": 123,
"group_sizes": [123],
"delimiters": [123]
}
}
]
}
] },
"json": { "components": [{ "field_actions": [
{
"field": "<string>",
"action": "<string>",
"reason": "<string>"
}
] }] }
},
"config_provided": True
}
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({
workspace_id: '<string>',
filter_id: '<string>',
name: '<string>',
name_provided: true,
description: '<string>',
description_provided: true,
config: {
text: {
components: [
{
action: 123,
matchers: [
{
substring: {value: '<string>'},
ssn: {delimiters: [123]},
credit_card: {delimiters: [123], require_luhn: true, min_digits: 123, max_digits: 123},
phone: {
delimiters: [123],
group_sizes: [123],
require_country_code: true,
require_parens: true
},
digits: {digits: 123, group_sizes: [123], delimiters: [123]}
}
]
}
]
},
json: {
components: [{field_actions: [{field: '<string>', action: '<string>', reason: '<string>'}]}]
}
},
config_provided: true
})
};
fetch('https://api.domesystems.ai/v1/guards/filters/{filter_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://api.domesystems.ai/v1/guards/filters/{filter_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([
'workspace_id' => '<string>',
'filter_id' => '<string>',
'name' => '<string>',
'name_provided' => true,
'description' => '<string>',
'description_provided' => true,
'config' => [
'text' => [
'components' => [
[
'action' => 123,
'matchers' => [
[
'substring' => [
'value' => '<string>'
],
'ssn' => [
'delimiters' => [
123
]
],
'credit_card' => [
'delimiters' => [
123
],
'require_luhn' => true,
'min_digits' => 123,
'max_digits' => 123
],
'phone' => [
'delimiters' => [
123
],
'group_sizes' => [
123
],
'require_country_code' => true,
'require_parens' => true
],
'digits' => [
'digits' => 123,
'group_sizes' => [
123
],
'delimiters' => [
123
]
]
]
]
]
]
],
'json' => [
'components' => [
[
'field_actions' => [
[
'field' => '<string>',
'action' => '<string>',
'reason' => '<string>'
]
]
]
]
]
],
'config_provided' => true
]),
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://api.domesystems.ai/v1/guards/filters/{filter_id}"
payload := strings.NewReader("{\n \"workspace_id\": \"<string>\",\n \"filter_id\": \"<string>\",\n \"name\": \"<string>\",\n \"name_provided\": true,\n \"description\": \"<string>\",\n \"description_provided\": true,\n \"config\": {\n \"text\": {\n \"components\": [\n {\n \"action\": 123,\n \"matchers\": [\n {\n \"substring\": {\n \"value\": \"<string>\"\n },\n \"ssn\": {\n \"delimiters\": [\n 123\n ]\n },\n \"credit_card\": {\n \"delimiters\": [\n 123\n ],\n \"require_luhn\": true,\n \"min_digits\": 123,\n \"max_digits\": 123\n },\n \"phone\": {\n \"delimiters\": [\n 123\n ],\n \"group_sizes\": [\n 123\n ],\n \"require_country_code\": true,\n \"require_parens\": true\n },\n \"digits\": {\n \"digits\": 123,\n \"group_sizes\": [\n 123\n ],\n \"delimiters\": [\n 123\n ]\n }\n }\n ]\n }\n ]\n },\n \"json\": {\n \"components\": [\n {\n \"field_actions\": [\n {\n \"field\": \"<string>\",\n \"action\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n ]\n }\n },\n \"config_provided\": true\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://api.domesystems.ai/v1/guards/filters/{filter_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"<string>\",\n \"filter_id\": \"<string>\",\n \"name\": \"<string>\",\n \"name_provided\": true,\n \"description\": \"<string>\",\n \"description_provided\": true,\n \"config\": {\n \"text\": {\n \"components\": [\n {\n \"action\": 123,\n \"matchers\": [\n {\n \"substring\": {\n \"value\": \"<string>\"\n },\n \"ssn\": {\n \"delimiters\": [\n 123\n ]\n },\n \"credit_card\": {\n \"delimiters\": [\n 123\n ],\n \"require_luhn\": true,\n \"min_digits\": 123,\n \"max_digits\": 123\n },\n \"phone\": {\n \"delimiters\": [\n 123\n ],\n \"group_sizes\": [\n 123\n ],\n \"require_country_code\": true,\n \"require_parens\": true\n },\n \"digits\": {\n \"digits\": 123,\n \"group_sizes\": [\n 123\n ],\n \"delimiters\": [\n 123\n ]\n }\n }\n ]\n }\n ]\n },\n \"json\": {\n \"components\": [\n {\n \"field_actions\": [\n {\n \"field\": \"<string>\",\n \"action\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n ]\n }\n },\n \"config_provided\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.domesystems.ai/v1/guards/filters/{filter_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 \"workspace_id\": \"<string>\",\n \"filter_id\": \"<string>\",\n \"name\": \"<string>\",\n \"name_provided\": true,\n \"description\": \"<string>\",\n \"description_provided\": true,\n \"config\": {\n \"text\": {\n \"components\": [\n {\n \"action\": 123,\n \"matchers\": [\n {\n \"substring\": {\n \"value\": \"<string>\"\n },\n \"ssn\": {\n \"delimiters\": [\n 123\n ]\n },\n \"credit_card\": {\n \"delimiters\": [\n 123\n ],\n \"require_luhn\": true,\n \"min_digits\": 123,\n \"max_digits\": 123\n },\n \"phone\": {\n \"delimiters\": [\n 123\n ],\n \"group_sizes\": [\n 123\n ],\n \"require_country_code\": true,\n \"require_parens\": true\n },\n \"digits\": {\n \"digits\": 123,\n \"group_sizes\": [\n 123\n ],\n \"delimiters\": [\n 123\n ]\n }\n }\n ]\n }\n ]\n },\n \"json\": {\n \"components\": [\n {\n \"field_actions\": [\n {\n \"field\": \"<string>\",\n \"action\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ]\n }\n ]\n }\n },\n \"config_provided\": true\n}"
response = http.request(request)
puts response.read_body{
"filter": {
"id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"description": "<string>",
"config": {
"text": {
"components": [
{
"action": 123,
"matchers": [
{
"substring": {
"value": "<string>"
},
"ssn": {
"delimiters": [
123
]
},
"credit_card": {
"delimiters": [
123
],
"require_luhn": true,
"min_digits": 123,
"max_digits": 123
},
"phone": {
"delimiters": [
123
],
"group_sizes": [
123
],
"require_country_code": true,
"require_parens": true
},
"digits": {
"digits": 123,
"group_sizes": [
123
],
"delimiters": [
123
]
}
}
]
}
]
},
"json": {
"components": [
{
"field_actions": [
{
"field": "<string>",
"action": "<string>",
"reason": "<string>"
}
]
}
]
}
},
"version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"kind": 123
}
}