Create a new policy
curl --request POST \
--url https://api.draftt.io/v1/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"policy": {
"name": "Certificate not in use",
"type": "governance",
"isActive": true,
"resource": "certificate",
"statusDefinitions": {
"Compliant": {
"isDefault": true,
"criticality": 10
},
"Non-Compliant": {
"rules": [
{
"conditions": [
{
"type": "filter",
"condition": {
"filter": {
"inUse": {
"$eq": false
}
}
}
}
]
}
],
"criticality": 20
}
},
"description": "Marks certificates that are not in use as Non-Compliant",
"query": {}
}
}
'import requests
url = "https://api.draftt.io/v1/policy"
payload = { "policy": {
"name": "Certificate not in use",
"type": "governance",
"isActive": True,
"resource": "certificate",
"statusDefinitions": {
"Compliant": {
"isDefault": True,
"criticality": 10
},
"Non-Compliant": {
"rules": [{ "conditions": [
{
"type": "filter",
"condition": { "filter": { "inUse": { "$eq": False } } }
}
] }],
"criticality": 20
}
},
"description": "Marks certificates that are not in use as Non-Compliant",
"query": {}
} }
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({
policy: {
name: 'Certificate not in use',
type: 'governance',
isActive: true,
resource: 'certificate',
statusDefinitions: {
Compliant: {isDefault: true, criticality: 10},
'Non-Compliant': {
rules: [{conditions: [{type: 'filter', condition: {filter: {inUse: {$eq: false}}}}]}],
criticality: 20
}
},
description: 'Marks certificates that are not in use as Non-Compliant',
query: {}
}
})
};
fetch('https://api.draftt.io/v1/policy', 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.draftt.io/v1/policy",
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([
'policy' => [
'name' => 'Certificate not in use',
'type' => 'governance',
'isActive' => true,
'resource' => 'certificate',
'statusDefinitions' => [
'Compliant' => [
'isDefault' => true,
'criticality' => 10
],
'Non-Compliant' => [
'rules' => [
[
'conditions' => [
[
'type' => 'filter',
'condition' => [
'filter' => [
'inUse' => [
'$eq' => false
]
]
]
]
]
]
],
'criticality' => 20
]
],
'description' => 'Marks certificates that are not in use as Non-Compliant',
'query' => [
]
]
]),
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.draftt.io/v1/policy"
payload := strings.NewReader("{\n \"policy\": {\n \"name\": \"Certificate not in use\",\n \"type\": \"governance\",\n \"isActive\": true,\n \"resource\": \"certificate\",\n \"statusDefinitions\": {\n \"Compliant\": {\n \"isDefault\": true,\n \"criticality\": 10\n },\n \"Non-Compliant\": {\n \"rules\": [\n {\n \"conditions\": [\n {\n \"type\": \"filter\",\n \"condition\": {\n \"filter\": {\n \"inUse\": {\n \"$eq\": false\n }\n }\n }\n }\n ]\n }\n ],\n \"criticality\": 20\n }\n },\n \"description\": \"Marks certificates that are not in use as Non-Compliant\",\n \"query\": {}\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://api.draftt.io/v1/policy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"policy\": {\n \"name\": \"Certificate not in use\",\n \"type\": \"governance\",\n \"isActive\": true,\n \"resource\": \"certificate\",\n \"statusDefinitions\": {\n \"Compliant\": {\n \"isDefault\": true,\n \"criticality\": 10\n },\n \"Non-Compliant\": {\n \"rules\": [\n {\n \"conditions\": [\n {\n \"type\": \"filter\",\n \"condition\": {\n \"filter\": {\n \"inUse\": {\n \"$eq\": false\n }\n }\n }\n }\n ]\n }\n ],\n \"criticality\": 20\n }\n },\n \"description\": \"Marks certificates that are not in use as Non-Compliant\",\n \"query\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.draftt.io/v1/policy")
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 \"policy\": {\n \"name\": \"Certificate not in use\",\n \"type\": \"governance\",\n \"isActive\": true,\n \"resource\": \"certificate\",\n \"statusDefinitions\": {\n \"Compliant\": {\n \"isDefault\": true,\n \"criticality\": 10\n },\n \"Non-Compliant\": {\n \"rules\": [\n {\n \"conditions\": [\n {\n \"type\": \"filter\",\n \"condition\": {\n \"filter\": {\n \"inUse\": {\n \"$eq\": false\n }\n }\n }\n }\n ]\n }\n ],\n \"criticality\": 20\n }\n },\n \"description\": \"Marks certificates that are not in use as Non-Compliant\",\n \"query\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"policy": {
"id": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}Policy
Create a new policy
POST
/
policy
Create a new policy
curl --request POST \
--url https://api.draftt.io/v1/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"policy": {
"name": "Certificate not in use",
"type": "governance",
"isActive": true,
"resource": "certificate",
"statusDefinitions": {
"Compliant": {
"isDefault": true,
"criticality": 10
},
"Non-Compliant": {
"rules": [
{
"conditions": [
{
"type": "filter",
"condition": {
"filter": {
"inUse": {
"$eq": false
}
}
}
}
]
}
],
"criticality": 20
}
},
"description": "Marks certificates that are not in use as Non-Compliant",
"query": {}
}
}
'import requests
url = "https://api.draftt.io/v1/policy"
payload = { "policy": {
"name": "Certificate not in use",
"type": "governance",
"isActive": True,
"resource": "certificate",
"statusDefinitions": {
"Compliant": {
"isDefault": True,
"criticality": 10
},
"Non-Compliant": {
"rules": [{ "conditions": [
{
"type": "filter",
"condition": { "filter": { "inUse": { "$eq": False } } }
}
] }],
"criticality": 20
}
},
"description": "Marks certificates that are not in use as Non-Compliant",
"query": {}
} }
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({
policy: {
name: 'Certificate not in use',
type: 'governance',
isActive: true,
resource: 'certificate',
statusDefinitions: {
Compliant: {isDefault: true, criticality: 10},
'Non-Compliant': {
rules: [{conditions: [{type: 'filter', condition: {filter: {inUse: {$eq: false}}}}]}],
criticality: 20
}
},
description: 'Marks certificates that are not in use as Non-Compliant',
query: {}
}
})
};
fetch('https://api.draftt.io/v1/policy', 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.draftt.io/v1/policy",
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([
'policy' => [
'name' => 'Certificate not in use',
'type' => 'governance',
'isActive' => true,
'resource' => 'certificate',
'statusDefinitions' => [
'Compliant' => [
'isDefault' => true,
'criticality' => 10
],
'Non-Compliant' => [
'rules' => [
[
'conditions' => [
[
'type' => 'filter',
'condition' => [
'filter' => [
'inUse' => [
'$eq' => false
]
]
]
]
]
]
],
'criticality' => 20
]
],
'description' => 'Marks certificates that are not in use as Non-Compliant',
'query' => [
]
]
]),
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.draftt.io/v1/policy"
payload := strings.NewReader("{\n \"policy\": {\n \"name\": \"Certificate not in use\",\n \"type\": \"governance\",\n \"isActive\": true,\n \"resource\": \"certificate\",\n \"statusDefinitions\": {\n \"Compliant\": {\n \"isDefault\": true,\n \"criticality\": 10\n },\n \"Non-Compliant\": {\n \"rules\": [\n {\n \"conditions\": [\n {\n \"type\": \"filter\",\n \"condition\": {\n \"filter\": {\n \"inUse\": {\n \"$eq\": false\n }\n }\n }\n }\n ]\n }\n ],\n \"criticality\": 20\n }\n },\n \"description\": \"Marks certificates that are not in use as Non-Compliant\",\n \"query\": {}\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://api.draftt.io/v1/policy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"policy\": {\n \"name\": \"Certificate not in use\",\n \"type\": \"governance\",\n \"isActive\": true,\n \"resource\": \"certificate\",\n \"statusDefinitions\": {\n \"Compliant\": {\n \"isDefault\": true,\n \"criticality\": 10\n },\n \"Non-Compliant\": {\n \"rules\": [\n {\n \"conditions\": [\n {\n \"type\": \"filter\",\n \"condition\": {\n \"filter\": {\n \"inUse\": {\n \"$eq\": false\n }\n }\n }\n }\n ]\n }\n ],\n \"criticality\": 20\n }\n },\n \"description\": \"Marks certificates that are not in use as Non-Compliant\",\n \"query\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.draftt.io/v1/policy")
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 \"policy\": {\n \"name\": \"Certificate not in use\",\n \"type\": \"governance\",\n \"isActive\": true,\n \"resource\": \"certificate\",\n \"statusDefinitions\": {\n \"Compliant\": {\n \"isDefault\": true,\n \"criticality\": 10\n },\n \"Non-Compliant\": {\n \"rules\": [\n {\n \"conditions\": [\n {\n \"type\": \"filter\",\n \"condition\": {\n \"filter\": {\n \"inUse\": {\n \"$eq\": false\n }\n }\n }\n }\n ]\n }\n ],\n \"criticality\": 20\n }\n },\n \"description\": \"Marks certificates that are not in use as Non-Compliant\",\n \"query\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"policy": {
"id": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Show child attributes
Show child attributes
Examples:
{
"name": "Certificate not in use",
"type": "governance",
"isActive": true,
"resource": "certificate",
"statusDefinitions": {
"Compliant": { "isDefault": true, "criticality": 10 },
"Non-Compliant": {
"rules": [
{
"conditions": [
{
"type": "filter",
"condition": { "filter": { "inUse": { "$eq": false } } }
}
]
}
],
"criticality": 20
}
},
"description": "Marks certificates that are not in use as Non-Compliant",
"query": {}
}
{
"name": "Inactive Database Components",
"type": "governance",
"isActive": true,
"resource": "component",
"statusDefinitions": {
"Active": { "isDefault": true, "criticality": 10 },
"Inactive": {
"rules": [
{
"conditions": [
{
"type": "filter",
"condition": {
"filter": {
"technology": { "$like": "rds*" },
"details$.database$.activeConnectionCount": { "$eq": 0 }
}
}
}
]
}
],
"criticality": 20
}
},
"description": "Identifies RDS databases with no active connections. Available details$ fields vary by technology - call POST /v1/component/detailsSchema to discover fields.",
"query": {
"filter": { "technology": { "$like": "rds*" } }
}
}
{
"name": "ELB TLS Compliance",
"type": "governance",
"isActive": true,
"resource": "component",
"statusDefinitions": {
"Non-Compliant": { "isDefault": true, "criticality": 20 },
"Compliant": {
"rules": [
{
"conditions": [
{
"type": "filter",
"condition": {
"filter": {
"details$.aws-elb$.scheme": { "$eq": "internal" }
}
}
}
]
},
{
"conditions": [
{
"type": "filter",
"condition": {
"filter": {
"details$.aws-elb$.scheme": { "$eq": "internet-facing" }
}
}
},
{
"type": "filter",
"condition": {
"filter": {
"details$.aws-elb$.listeners$.__drafttArrayAny__$.minimumSupportedTlsVersion": { "$nin": ["1.0", "1.1"] }
}
}
}
]
}
],
"criticality": 10
}
},
"description": "Compliant if load balancer is internal OR (internet-facing AND all listeners have TLS >= 1.2). Demonstrates multi-rule OR logic and array element selectors.",
"query": {
"filter": { "technology": { "$eq": "aws-elb" } }
}
}
Response
Success
Show child attributes
Show child attributes