Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "data": {
# "type": "security_filters",
# "attributes": {
# "exclusion_filters": [
# {
# "name": "<string>",
# "query": "<string>"
# },
# {
# "name": "<string>",
# "query": "<string>"
# }
# ],
# "filtered_data_type": "logs",
# "is_enabled": "<boolean>",
# "name": "<string>",
# "query": "<string>",
# "version": "<integer>"
# }
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("data.type","security_filters")
json.UpdateString("data.attributes.exclusion_filters[0].name","<string>")
json.UpdateString("data.attributes.exclusion_filters[0].query","<string>")
json.UpdateString("data.attributes.exclusion_filters[1].name","<string>")
json.UpdateString("data.attributes.exclusion_filters[1].query","<string>")
json.UpdateString("data.attributes.filtered_data_type","logs")
json.UpdateString("data.attributes.is_enabled","<boolean>")
json.UpdateString("data.attributes.name","<string>")
json.UpdateString("data.attributes.query","<string>")
json.UpdateString("data.attributes.version","<integer>")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")
sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": {
# "attributes": {
# "exclusion_filters": [
# {
# "name": "<string>",
# "query": "<string>"
# },
# {
# "name": "<string>",
# "query": "<string>"
# }
# ],
# "filtered_data_type": "logs",
# "is_builtin": "<boolean>",
# "is_enabled": "<boolean>",
# "name": "<string>",
# "query": "<string>",
# "version": "<integer>"
# },
# "id": "<string>",
# "type": "security_filters"
# },
# "meta": {
# "warning": "<string>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Filtered_data_type = jResp.stringOf("data.attributes.filtered_data_type")
Is_builtin = jResp.stringOf("data.attributes.is_builtin")
Is_enabled = jResp.stringOf("data.attributes.is_enabled")
Name = jResp.stringOf("data.attributes.name")
Query = jResp.stringOf("data.attributes.query")
Version = jResp.stringOf("data.attributes.version")
Id = jResp.stringOf("data.id")
v_Type = jResp.stringOf("data.type")
Warning = jResp.stringOf("meta.warning")
i = 0
count_i = jResp.SizeOfArray("data.attributes.exclusion_filters")
while i < count_i
jResp.put_I(i)
name = jResp.stringOf("data.attributes.exclusion_filters[i].name")
query = jResp.stringOf("data.attributes.exclusion_filters[i].query")
i = i + 1
end
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "security_filters",
"attributes": {
"exclusion_filters": [
{
"name": "<string>",
"query": "<string>"
},
{
"name": "<string>",
"query": "<string>"
}
],
"filtered_data_type": "logs",
"is_enabled": "<boolean>",
"name": "<string>",
"query": "<string>",
"version": "<integer>"
}
}
}'
https://api.app.ddog-gov.com/api/v2/security_monitoring/configuration/security_filters/:security_filter_id
Postman Collection Item JSON
{
"name": "Update a security filter",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"version\": \"<integer>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id",
"value": "<string>"
}
]
},
"description": "Update a specific security filter.\nReturns the security filter object when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"version\": \"<integer>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_builtin\": \"<boolean>\",\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"version\": \"<integer>\"\n },\n \"id\": \"<string>\",\n \"type\": \"security_filters\"\n },\n \"meta\": {\n \"warning\": \"<string>\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"version\": \"<integer>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"version\": \"<integer>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"version\": \"<integer>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Concurrent Modification",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"version\": \"<integer>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"security_filters\",\n \"attributes\": {\n \"exclusion_filters\": [\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"filtered_data_type\": \"logs\",\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"version\": \"<integer>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"configuration",
"security_filters",
":security_filter_id"
],
"variable": [
{
"key": "security_filter_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
