Create a virtual tag rule
Adds a rule at the bottom of its tag key so it cannot outrank an existing rule. The predicate, and the value expression of an inherited rule, are compiled before the rule is stored. A rule is written one of three ways and exactly one may be sent: expression as CostQL text, clause as a single chip, or node as a tree of chips. A node is rendered server-side by the same renderer the decompose endpoint round-trips through, so a rule saved from chips reads back as the identical tree, and sending node together with expression or clause is a 400 rather than a silent pick. Every leaf of a node is checked like a flat clause, so a tree cannot smuggle in a field or operator the clause path would refuse.
curl --request POST \
--url https://api.costgraph.ai/api/v1/tenant/virtual-tags \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"clause": {
"field": "<string>",
"match_value": "<string>",
"operator": "<string>"
},
"description": "<string>",
"expression": "<string>",
"inherited_from": "<string>",
"key": "<string>",
"node": {
"children": "<array>",
"clause": {
"field": "<string>",
"match_value": "<string>",
"operator": "<string>"
},
"kind": "<string>"
},
"origin": "<string>",
"rule_type": "<string>",
"scope": "<string>",
"source_text": "<string>",
"valid_from": "<string>",
"valid_to": "<string>",
"value": "<string>"
}
'import requests
url = "https://api.costgraph.ai/api/v1/tenant/virtual-tags"
payload = {
"clause": {
"field": "<string>",
"match_value": "<string>",
"operator": "<string>"
},
"description": "<string>",
"expression": "<string>",
"inherited_from": "<string>",
"key": "<string>",
"node": {
"children": "<array>",
"clause": {
"field": "<string>",
"match_value": "<string>",
"operator": "<string>"
},
"kind": "<string>"
},
"origin": "<string>",
"rule_type": "<string>",
"scope": "<string>",
"source_text": "<string>",
"valid_from": "<string>",
"valid_to": "<string>",
"value": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clause: {field: '<string>', match_value: '<string>', operator: '<string>'},
description: '<string>',
expression: '<string>',
inherited_from: '<string>',
key: '<string>',
node: {
children: '<array>',
clause: {field: '<string>', match_value: '<string>', operator: '<string>'},
kind: '<string>'
},
origin: '<string>',
rule_type: '<string>',
scope: '<string>',
source_text: '<string>',
valid_from: '<string>',
valid_to: '<string>',
value: '<string>'
})
};
fetch('https://api.costgraph.ai/api/v1/tenant/virtual-tags', 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.costgraph.ai/api/v1/tenant/virtual-tags",
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([
'clause' => [
'field' => '<string>',
'match_value' => '<string>',
'operator' => '<string>'
],
'description' => '<string>',
'expression' => '<string>',
'inherited_from' => '<string>',
'key' => '<string>',
'node' => [
'children' => '<array>',
'clause' => [
'field' => '<string>',
'match_value' => '<string>',
'operator' => '<string>'
],
'kind' => '<string>'
],
'origin' => '<string>',
'rule_type' => '<string>',
'scope' => '<string>',
'source_text' => '<string>',
'valid_from' => '<string>',
'valid_to' => '<string>',
'value' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.costgraph.ai/api/v1/tenant/virtual-tags"
payload := strings.NewReader("{\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expression\": \"<string>\",\n \"inherited_from\": \"<string>\",\n \"key\": \"<string>\",\n \"node\": {\n \"children\": \"<array>\",\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"kind\": \"<string>\"\n },\n \"origin\": \"<string>\",\n \"rule_type\": \"<string>\",\n \"scope\": \"<string>\",\n \"source_text\": \"<string>\",\n \"valid_from\": \"<string>\",\n \"valid_to\": \"<string>\",\n \"value\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.costgraph.ai/api/v1/tenant/virtual-tags")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expression\": \"<string>\",\n \"inherited_from\": \"<string>\",\n \"key\": \"<string>\",\n \"node\": {\n \"children\": \"<array>\",\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"kind\": \"<string>\"\n },\n \"origin\": \"<string>\",\n \"rule_type\": \"<string>\",\n \"scope\": \"<string>\",\n \"source_text\": \"<string>\",\n \"valid_from\": \"<string>\",\n \"valid_to\": \"<string>\",\n \"value\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/tenant/virtual-tags")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expression\": \"<string>\",\n \"inherited_from\": \"<string>\",\n \"key\": \"<string>\",\n \"node\": {\n \"children\": \"<array>\",\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"kind\": \"<string>\"\n },\n \"origin\": \"<string>\",\n \"rule_type\": \"<string>\",\n \"scope\": \"<string>\",\n \"source_text\": \"<string>\",\n \"valid_from\": \"<string>\",\n \"valid_to\": \"<string>\",\n \"value\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "some message",
"status": "success",
"data": {
"active": true,
"created_at": "<string>",
"description": "<string>",
"expression": "<string>",
"expression_hash": "<string>",
"field": "<string>",
"id": "<string>",
"inherited_from": "<string>",
"key": "<string>",
"match_value": "<string>",
"operator": "<string>",
"origin": "<string>",
"rank": 123,
"rule_type": "<string>",
"scope": "<string>",
"source_text": "<string>",
"tenant_id": "<string>",
"updated_at": "<string>",
"valid_from": "<string>",
"valid_to": "<string>",
"value": "<string>"
}
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}Authorizations
Enter "Bearer {token}"
Body
Rule to create
Was this page helpful?
curl --request POST \
--url https://api.costgraph.ai/api/v1/tenant/virtual-tags \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"clause": {
"field": "<string>",
"match_value": "<string>",
"operator": "<string>"
},
"description": "<string>",
"expression": "<string>",
"inherited_from": "<string>",
"key": "<string>",
"node": {
"children": "<array>",
"clause": {
"field": "<string>",
"match_value": "<string>",
"operator": "<string>"
},
"kind": "<string>"
},
"origin": "<string>",
"rule_type": "<string>",
"scope": "<string>",
"source_text": "<string>",
"valid_from": "<string>",
"valid_to": "<string>",
"value": "<string>"
}
'import requests
url = "https://api.costgraph.ai/api/v1/tenant/virtual-tags"
payload = {
"clause": {
"field": "<string>",
"match_value": "<string>",
"operator": "<string>"
},
"description": "<string>",
"expression": "<string>",
"inherited_from": "<string>",
"key": "<string>",
"node": {
"children": "<array>",
"clause": {
"field": "<string>",
"match_value": "<string>",
"operator": "<string>"
},
"kind": "<string>"
},
"origin": "<string>",
"rule_type": "<string>",
"scope": "<string>",
"source_text": "<string>",
"valid_from": "<string>",
"valid_to": "<string>",
"value": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clause: {field: '<string>', match_value: '<string>', operator: '<string>'},
description: '<string>',
expression: '<string>',
inherited_from: '<string>',
key: '<string>',
node: {
children: '<array>',
clause: {field: '<string>', match_value: '<string>', operator: '<string>'},
kind: '<string>'
},
origin: '<string>',
rule_type: '<string>',
scope: '<string>',
source_text: '<string>',
valid_from: '<string>',
valid_to: '<string>',
value: '<string>'
})
};
fetch('https://api.costgraph.ai/api/v1/tenant/virtual-tags', 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.costgraph.ai/api/v1/tenant/virtual-tags",
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([
'clause' => [
'field' => '<string>',
'match_value' => '<string>',
'operator' => '<string>'
],
'description' => '<string>',
'expression' => '<string>',
'inherited_from' => '<string>',
'key' => '<string>',
'node' => [
'children' => '<array>',
'clause' => [
'field' => '<string>',
'match_value' => '<string>',
'operator' => '<string>'
],
'kind' => '<string>'
],
'origin' => '<string>',
'rule_type' => '<string>',
'scope' => '<string>',
'source_text' => '<string>',
'valid_from' => '<string>',
'valid_to' => '<string>',
'value' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.costgraph.ai/api/v1/tenant/virtual-tags"
payload := strings.NewReader("{\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expression\": \"<string>\",\n \"inherited_from\": \"<string>\",\n \"key\": \"<string>\",\n \"node\": {\n \"children\": \"<array>\",\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"kind\": \"<string>\"\n },\n \"origin\": \"<string>\",\n \"rule_type\": \"<string>\",\n \"scope\": \"<string>\",\n \"source_text\": \"<string>\",\n \"valid_from\": \"<string>\",\n \"valid_to\": \"<string>\",\n \"value\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.costgraph.ai/api/v1/tenant/virtual-tags")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expression\": \"<string>\",\n \"inherited_from\": \"<string>\",\n \"key\": \"<string>\",\n \"node\": {\n \"children\": \"<array>\",\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"kind\": \"<string>\"\n },\n \"origin\": \"<string>\",\n \"rule_type\": \"<string>\",\n \"scope\": \"<string>\",\n \"source_text\": \"<string>\",\n \"valid_from\": \"<string>\",\n \"valid_to\": \"<string>\",\n \"value\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/tenant/virtual-tags")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"expression\": \"<string>\",\n \"inherited_from\": \"<string>\",\n \"key\": \"<string>\",\n \"node\": {\n \"children\": \"<array>\",\n \"clause\": {\n \"field\": \"<string>\",\n \"match_value\": \"<string>\",\n \"operator\": \"<string>\"\n },\n \"kind\": \"<string>\"\n },\n \"origin\": \"<string>\",\n \"rule_type\": \"<string>\",\n \"scope\": \"<string>\",\n \"source_text\": \"<string>\",\n \"valid_from\": \"<string>\",\n \"valid_to\": \"<string>\",\n \"value\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "some message",
"status": "success",
"data": {
"active": true,
"created_at": "<string>",
"description": "<string>",
"expression": "<string>",
"expression_hash": "<string>",
"field": "<string>",
"id": "<string>",
"inherited_from": "<string>",
"key": "<string>",
"match_value": "<string>",
"operator": "<string>",
"origin": "<string>",
"rank": 123,
"rule_type": "<string>",
"scope": "<string>",
"source_text": "<string>",
"tenant_id": "<string>",
"updated_at": "<string>",
"valid_from": "<string>",
"valid_to": "<string>",
"value": "<string>"
}
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}