Chilkat Online Tools

autoit / Datadog API Collection / Update Scanning Rule

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

; 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": {
;     "attributes": {
;       "description": "<string>",
;       "excluded_namespaces": [
;         "<string>",
;         "<string>"
;       ],
;       "is_enabled": "<boolean>",
;       "name": "<string>",
;       "namespaces": [
;         "<string>",
;         "<string>"
;       ],
;       "pattern": "<string>",
;       "tags": [
;         "<string>",
;         "<string>"
;       ],
;       "text_replacement": {
;         "number_of_chars": "<long>",
;         "replacement_string": "<string>",
;         "type": "none"
;       }
;     },
;     "id": "<string>",
;     "relationships": {
;       "group": {
;         "data": {
;           "id": "<string>",
;           "type": "sensitive_data_scanner_group"
;         }
;       },
;       "standard_pattern": {
;         "data": {
;           "id": "<string>",
;           "type": "sensitive_data_scanner_standard_pattern"
;         }
;       }
;     },
;     "type": "sensitive_data_scanner_rule"
;   },
;   "meta": {
;     "version": "<long>"
;   }
; }

$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("data.attributes.description","<string>")
$oJson.UpdateString("data.attributes.excluded_namespaces[0]","<string>")
$oJson.UpdateString("data.attributes.excluded_namespaces[1]","<string>")
$oJson.UpdateString("data.attributes.is_enabled","<boolean>")
$oJson.UpdateString("data.attributes.name","<string>")
$oJson.UpdateString("data.attributes.namespaces[0]","<string>")
$oJson.UpdateString("data.attributes.namespaces[1]","<string>")
$oJson.UpdateString("data.attributes.pattern","<string>")
$oJson.UpdateString("data.attributes.tags[0]","<string>")
$oJson.UpdateString("data.attributes.tags[1]","<string>")
$oJson.UpdateString("data.attributes.text_replacement.number_of_chars","<long>")
$oJson.UpdateString("data.attributes.text_replacement.replacement_string","<string>")
$oJson.UpdateString("data.attributes.text_replacement.type","none")
$oJson.UpdateString("data.id","<string>")
$oJson.UpdateString("data.relationships.group.data.id","<string>")
$oJson.UpdateString("data.relationships.group.data.type","sensitive_data_scanner_group")
$oJson.UpdateString("data.relationships.standard_pattern.data.id","<string>")
$oJson.UpdateString("data.relationships.standard_pattern.data.type","sensitive_data_scanner_standard_pattern")
$oJson.UpdateString("data.type","sensitive_data_scanner_rule")
$oJson.UpdateString("meta.version","<long>")

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbRequestBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/rules/:rule_id",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "meta": {
;     "version": "<long>"
;   }
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sVersion = $oJResp.StringOf("meta.version")

Curl Command

curl -X PATCH
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "attributes": {
      "description": "<string>",
      "excluded_namespaces": [
        "<string>",
        "<string>"
      ],
      "is_enabled": "<boolean>",
      "name": "<string>",
      "namespaces": [
        "<string>",
        "<string>"
      ],
      "pattern": "<string>",
      "tags": [
        "<string>",
        "<string>"
      ],
      "text_replacement": {
        "number_of_chars": "<long>",
        "replacement_string": "<string>",
        "type": "none"
      }
    },
    "id": "<string>",
    "relationships": {
      "group": {
        "data": {
          "id": "<string>",
          "type": "sensitive_data_scanner_group"
        }
      },
      "standard_pattern": {
        "data": {
          "id": "<string>",
          "type": "sensitive_data_scanner_standard_pattern"
        }
      }
    },
    "type": "sensitive_data_scanner_rule"
  },
  "meta": {
    "version": "<long>"
  }
}'
https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/rules/:rule_id

Postman Collection Item JSON

{
  "name": "Update Scanning Rule",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"description\": \"<string>\",\n      \"excluded_namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"pattern\": \"<string>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"text_replacement\": {\n        \"number_of_chars\": \"<long>\",\n        \"replacement_string\": \"<string>\",\n        \"type\": \"none\"\n      }\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"group\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_group\"\n        }\n      },\n      \"standard_pattern\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_standard_pattern\"\n        }\n      }\n    },\n    \"type\": \"sensitive_data_scanner_rule\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "sensitive-data-scanner",
        "config",
        "rules",
        ":rule_id"
      ],
      "variable": [
        {
          "key": "rule_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Update a scanning rule.\nThe request body MUST NOT include a standard_pattern relationship, as that relationship\nis non-editable. Trying to edit the regex attribute of a rule with a standard_pattern\nrelationship will also result in an error."
  },
  "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    \"attributes\": {\n      \"description\": \"<string>\",\n      \"excluded_namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"pattern\": \"<string>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"text_replacement\": {\n        \"number_of_chars\": \"<long>\",\n        \"replacement_string\": \"<string>\",\n        \"type\": \"none\"\n      }\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"group\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_group\"\n        }\n      },\n      \"standard_pattern\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_standard_pattern\"\n        }\n      }\n    },\n    \"type\": \"sensitive_data_scanner_rule\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "rules",
            ":rule_id"
          ],
          "variable": [
            {
              "key": "rule_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"meta\": {\n    \"version\": \"<long>\"\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    \"attributes\": {\n      \"description\": \"<string>\",\n      \"excluded_namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"pattern\": \"<string>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"text_replacement\": {\n        \"number_of_chars\": \"<long>\",\n        \"replacement_string\": \"<string>\",\n        \"type\": \"none\"\n      }\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"group\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_group\"\n        }\n      },\n      \"standard_pattern\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_standard_pattern\"\n        }\n      }\n    },\n    \"type\": \"sensitive_data_scanner_rule\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "rules",
            ":rule_id"
          ],
          "variable": [
            {
              "key": "rule_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": "Authentication Error",
      "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    \"attributes\": {\n      \"description\": \"<string>\",\n      \"excluded_namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"pattern\": \"<string>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"text_replacement\": {\n        \"number_of_chars\": \"<long>\",\n        \"replacement_string\": \"<string>\",\n        \"type\": \"none\"\n      }\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"group\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_group\"\n        }\n      },\n      \"standard_pattern\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_standard_pattern\"\n        }\n      }\n    },\n    \"type\": \"sensitive_data_scanner_rule\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "rules",
            ":rule_id"
          ],
          "variable": [
            {
              "key": "rule_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    \"attributes\": {\n      \"description\": \"<string>\",\n      \"excluded_namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"pattern\": \"<string>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"text_replacement\": {\n        \"number_of_chars\": \"<long>\",\n        \"replacement_string\": \"<string>\",\n        \"type\": \"none\"\n      }\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"group\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_group\"\n        }\n      },\n      \"standard_pattern\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_standard_pattern\"\n        }\n      }\n    },\n    \"type\": \"sensitive_data_scanner_rule\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "rules",
            ":rule_id"
          ],
          "variable": [
            {
              "key": "rule_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": "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    \"attributes\": {\n      \"description\": \"<string>\",\n      \"excluded_namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"namespaces\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"pattern\": \"<string>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"text_replacement\": {\n        \"number_of_chars\": \"<long>\",\n        \"replacement_string\": \"<string>\",\n        \"type\": \"none\"\n      }\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"group\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_group\"\n        }\n      },\n      \"standard_pattern\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_standard_pattern\"\n        }\n      }\n    },\n    \"type\": \"sensitive_data_scanner_rule\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "rules",
            ":rule_id"
          ],
          "variable": [
            {
              "key": "rule_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}"
    }
  ]
}