Chilkat Online Tools

Foxpro / Datadog API Collection / Create an index

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnSample_rate
LOCAL lcFilterQuery
LOCAL lnIs_enabled
LOCAL lcName
LOCAL lcQuery
LOCAL lnDaily_limit
LOCAL lnIs_rate_limited
LOCAL lnNum_retention_days
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Use this online tool to generate code from sample JSON: Generate Code to Create JSON

* The following JSON is sent in the request body.

* {
*   "name": "main",
*   "filter": {
*     "query": "source:python"
*   },
*   "daily_limit": 300000000,
*   "exclusion_filters": [
*     {
*       "name": "payment",
*       "filter": {
*         "sample_rate": 1,
*         "query": "*"
*       },
*       "is_enabled": false
*     },
*     {
*       "name": "payment",
*       "filter": {
*         "sample_rate": 1,
*         "query": "*"
*       },
*       "is_enabled": true
*     }
*   ],
*   "is_rate_limited": false,
*   "num_retention_days": 15
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("name","main")
loJson.UpdateString("filter.query","source:python")
loJson.UpdateInt("daily_limit",300000000)
loJson.UpdateString("exclusion_filters[0].name","payment")
loJson.UpdateInt("exclusion_filters[0].filter.sample_rate",1)
loJson.UpdateString("exclusion_filters[0].filter.query","*")
loJson.UpdateBool("exclusion_filters[0].is_enabled",0)
loJson.UpdateString("exclusion_filters[1].name","payment")
loJson.UpdateInt("exclusion_filters[1].filter.sample_rate",1)
loJson.UpdateString("exclusion_filters[1].filter.query","*")
loJson.UpdateBool("exclusion_filters[1].is_enabled",1)
loJson.UpdateBool("is_rate_limited",0)
loJson.UpdateInt("num_retention_days",15)

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.PostJson3("https://api.app.ddog-gov.com/api/v1/logs/config/indexes","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "name": "main",
*   "filter": {
*     "query": "source:python"
*   },
*   "daily_limit": 300000000,
*   "exclusion_filters": [
*     {
*       "name": "payment",
*       "filter": {
*         "sample_rate": 1,
*         "query": "*"
*       },
*       "is_enabled": false
*     },
*     {
*       "name": "payment",
*       "filter": {
*         "sample_rate": 1,
*         "query": "*"
*       },
*       "is_enabled": true
*     }
*   ],
*   "is_rate_limited": false,
*   "num_retention_days": 15
* }

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

lcName = loJResp.StringOf("name")
lcQuery = loJResp.StringOf("filter.query")
lnDaily_limit = loJResp.IntOf("daily_limit")
lnIs_rate_limited = loJResp.BoolOf("is_rate_limited")
lnNum_retention_days = loJResp.IntOf("num_retention_days")
i = 0
lnCount_i = loJResp.SizeOfArray("exclusion_filters")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcName = loJResp.StringOf("exclusion_filters[i].name")
    lnSample_rate = loJResp.IntOf("exclusion_filters[i].filter.sample_rate")
    lcFilterQuery = loJResp.StringOf("exclusion_filters[i].filter.query")
    lnIs_enabled = loJResp.BoolOf("exclusion_filters[i].is_enabled")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "name": "main",
  "filter": {
    "query": "source:python"
  },
  "daily_limit": 300000000,
  "exclusion_filters": [
    {
      "name": "payment",
      "filter": {
        "sample_rate": 1,
        "query": "*"
      },
      "is_enabled": false
    },
    {
      "name": "payment",
      "filter": {
        "sample_rate": 1,
        "query": "*"
      },
      "is_enabled": true
    }
  ],
  "is_rate_limited": false,
  "num_retention_days": 15
}'
https://api.app.ddog-gov.com/api/v1/logs/config/indexes

Postman Collection Item JSON

{
  "name": "Create an index",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"name\": \"main\",\n  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"exclusion_filters\": [\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": false\n    },\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": true\n    }\n  ],\n  \"is_rate_limited\": false,\n  \"num_retention_days\": 15\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v1/logs/config/indexes",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "logs",
        "config",
        "indexes"
      ]
    },
    "description": "Creates a new index. Returns the Index object passed in the request body when the request is successful."
  },
  "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  \"name\": \"main\",\n  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"exclusion_filters\": [\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": false\n    },\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": true\n    }\n  ],\n  \"is_rate_limited\": false,\n  \"num_retention_days\": 15\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/logs/config/indexes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"name\": \"main\",\n  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"exclusion_filters\": [\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": false\n    },\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": true\n    }\n  ],\n  \"is_rate_limited\": false,\n  \"num_retention_days\": 15\n}"
    },
    {
      "name": "Invalid Parameter 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  \"name\": \"main\",\n  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"exclusion_filters\": [\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": false\n    },\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": true\n    }\n  ],\n  \"is_rate_limited\": false,\n  \"num_retention_days\": 15\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/logs/config/indexes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "null"
    },
    {
      "name": "Forbidden",
      "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  \"name\": \"main\",\n  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"exclusion_filters\": [\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": false\n    },\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": true\n    }\n  ],\n  \"is_rate_limited\": false,\n  \"num_retention_days\": 15\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/logs/config/indexes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\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  \"name\": \"main\",\n  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"exclusion_filters\": [\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": false\n    },\n    {\n      \"name\": \"payment\",\n      \"filter\": {\n        \"sample_rate\": 1,\n        \"query\": \"*\"\n      },\n      \"is_enabled\": true\n    }\n  ],\n  \"is_rate_limited\": false,\n  \"num_retention_days\": 15\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/logs/config/indexes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}