Chilkat Online Tools

PureBasic / Datadog API Collection / Create Scanning Rule

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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": "sensitive_data_scanner_rule",
    ;     "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"
    ;       }
    ;     },
    ;     "relationships": {
    ;       "group": {
    ;         "data": {
    ;           "id": "<string>",
    ;           "type": "sensitive_data_scanner_group"
    ;         }
    ;       },
    ;       "standard_pattern": {
    ;         "data": {
    ;           "id": "<string>",
    ;           "type": "sensitive_data_scanner_standard_pattern"
    ;         }
    ;       }
    ;     }
    ;   },
    ;   "meta": {
    ;     "version": "<long>"
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"data.type","sensitive_data_scanner_rule")
    CkJsonObject::ckUpdateString(json,"data.attributes.description","<string>")
    CkJsonObject::ckUpdateString(json,"data.attributes.excluded_namespaces[0]","<string>")
    CkJsonObject::ckUpdateString(json,"data.attributes.excluded_namespaces[1]","<string>")
    CkJsonObject::ckUpdateString(json,"data.attributes.is_enabled","<boolean>")
    CkJsonObject::ckUpdateString(json,"data.attributes.name","<string>")
    CkJsonObject::ckUpdateString(json,"data.attributes.namespaces[0]","<string>")
    CkJsonObject::ckUpdateString(json,"data.attributes.namespaces[1]","<string>")
    CkJsonObject::ckUpdateString(json,"data.attributes.pattern","<string>")
    CkJsonObject::ckUpdateString(json,"data.attributes.tags[0]","<string>")
    CkJsonObject::ckUpdateString(json,"data.attributes.tags[1]","<string>")
    CkJsonObject::ckUpdateString(json,"data.attributes.text_replacement.number_of_chars","<long>")
    CkJsonObject::ckUpdateString(json,"data.attributes.text_replacement.replacement_string","<string>")
    CkJsonObject::ckUpdateString(json,"data.attributes.text_replacement.type","none")
    CkJsonObject::ckUpdateString(json,"data.relationships.group.data.id","<string>")
    CkJsonObject::ckUpdateString(json,"data.relationships.group.data.type","sensitive_data_scanner_group")
    CkJsonObject::ckUpdateString(json,"data.relationships.standard_pattern.data.id","<string>")
    CkJsonObject::ckUpdateString(json,"data.relationships.standard_pattern.data.type","sensitive_data_scanner_standard_pattern")
    CkJsonObject::ckUpdateString(json,"meta.version","<long>")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/rules","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "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>"
    ;   }
    ; }

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

    strVal.s

    Description.s = CkJsonObject::ckStringOf(jResp,"data.attributes.description")
    Is_enabled.s = CkJsonObject::ckStringOf(jResp,"data.attributes.is_enabled")
    Name.s = CkJsonObject::ckStringOf(jResp,"data.attributes.name")
    Pattern.s = CkJsonObject::ckStringOf(jResp,"data.attributes.pattern")
    Number_of_chars.s = CkJsonObject::ckStringOf(jResp,"data.attributes.text_replacement.number_of_chars")
    Replacement_string.s = CkJsonObject::ckStringOf(jResp,"data.attributes.text_replacement.replacement_string")
    v_Type.s = CkJsonObject::ckStringOf(jResp,"data.attributes.text_replacement.type")
    Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
    DataId.s = CkJsonObject::ckStringOf(jResp,"data.relationships.group.data.id")
    DataType.s = CkJsonObject::ckStringOf(jResp,"data.relationships.group.data.type")
    DataId = CkJsonObject::ckStringOf(jResp,"data.relationships.standard_pattern.data.id")
    DataType = CkJsonObject::ckStringOf(jResp,"data.relationships.standard_pattern.data.type")
    dataType.s = CkJsonObject::ckStringOf(jResp,"data.type")
    Version.s = CkJsonObject::ckStringOf(jResp,"meta.version")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.attributes.excluded_namespaces")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"data.attributes.excluded_namespaces[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"data.attributes.namespaces")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"data.attributes.namespaces[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"data.attributes.tags")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"data.attributes.tags[i]")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "type": "sensitive_data_scanner_rule",
    "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"
      }
    },
    "relationships": {
      "group": {
        "data": {
          "id": "<string>",
          "type": "sensitive_data_scanner_group"
        }
      },
      "standard_pattern": {
        "data": {
          "id": "<string>",
          "type": "sensitive_data_scanner_standard_pattern"
        }
      }
    }
  },
  "meta": {
    "version": "<long>"
  }
}'
https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/rules

Postman Collection Item JSON

{
  "name": "Create Scanning Rule",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"type\": \"sensitive_data_scanner_rule\",\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    \"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  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "sensitive-data-scanner",
        "config",
        "rules"
      ]
    },
    "description": "Create a scanning rule in a sensitive data scanner group, ordered last.\nThe posted rule MUST include a group relationship.\nIt MUST include either a standard_pattern relationship or a regex attribute, but not both.\nIf included_attributes is empty or missing, we will scan all attributes except\nexcluded_attributes. If both are missing, we will scan the whole event."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "POST",
        "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\": \"sensitive_data_scanner_rule\",\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    \"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  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "rules"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\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}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "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\": \"sensitive_data_scanner_rule\",\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    \"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  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "rules"
          ]
        }
      },
      "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": "POST",
        "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\": \"sensitive_data_scanner_rule\",\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    \"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  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "rules"
          ]
        }
      },
      "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": "Too many requests",
      "originalRequest": {
        "method": "POST",
        "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\": \"sensitive_data_scanner_rule\",\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    \"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  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "rules"
          ]
        }
      },
      "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}"
    }
  ]
}