Chilkat Online Tools

VB6 / 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.

Dim http As New ChilkatHttp
Dim success As Long

' 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>"
'   }
' }

Dim json As New ChilkatJsonObject
success = json.UpdateString("data.attributes.description","<string>")
success = json.UpdateString("data.attributes.excluded_namespaces[0]","<string>")
success = json.UpdateString("data.attributes.excluded_namespaces[1]","<string>")
success = json.UpdateString("data.attributes.is_enabled","<boolean>")
success = json.UpdateString("data.attributes.name","<string>")
success = json.UpdateString("data.attributes.namespaces[0]","<string>")
success = json.UpdateString("data.attributes.namespaces[1]","<string>")
success = json.UpdateString("data.attributes.pattern","<string>")
success = json.UpdateString("data.attributes.tags[0]","<string>")
success = json.UpdateString("data.attributes.tags[1]","<string>")
success = json.UpdateString("data.attributes.text_replacement.number_of_chars","<long>")
success = json.UpdateString("data.attributes.text_replacement.replacement_string","<string>")
success = json.UpdateString("data.attributes.text_replacement.type","none")
success = json.UpdateString("data.id","<string>")
success = json.UpdateString("data.relationships.group.data.id","<string>")
success = json.UpdateString("data.relationships.group.data.type","sensitive_data_scanner_group")
success = json.UpdateString("data.relationships.standard_pattern.data.id","<string>")
success = json.UpdateString("data.relationships.standard_pattern.data.type","sensitive_data_scanner_standard_pattern")
success = json.UpdateString("data.type","sensitive_data_scanner_rule")
success = json.UpdateString("meta.version","<long>")

http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"

Dim sbRequestBody As New ChilkatStringBuilder
success = json.EmitSb(sbRequestBody)

Dim resp As ChilkatHttpResponse
Set resp = http.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/rules/:rule_id",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim Version As String
Version = jResp.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}"
    }
  ]
}