Chilkat Online Tools

PowerBuilder / Datadog API Collection / Get an index

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Sample_rate
string ls_FilterQuery
integer li_Is_enabled
string ls_Name
string ls_Query
integer li_Daily_limit
integer li_Is_rate_limited
integer li_Num_retention_days
integer i
integer li_Count_i

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.SetRequestHeader("Accept","application/json")

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/logs/config/indexes/:name",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

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

ls_Name = loo_JResp.StringOf("name")
ls_Query = loo_JResp.StringOf("filter.query")
li_Daily_limit = loo_JResp.IntOf("daily_limit")
li_Is_rate_limited = loo_JResp.BoolOf("is_rate_limited")
li_Num_retention_days = loo_JResp.IntOf("num_retention_days")
i = 0
li_Count_i = loo_JResp.SizeOfArray("exclusion_filters")
do while i < li_Count_i
    loo_JResp.I = i
    ls_Name = loo_JResp.StringOf("exclusion_filters[i].name")
    li_Sample_rate = loo_JResp.IntOf("exclusion_filters[i].filter.sample_rate")
    ls_FilterQuery = loo_JResp.StringOf("exclusion_filters[i].filter.query")
    li_Is_enabled = loo_JResp.BoolOf("exclusion_filters[i].is_enabled")
    i = i + 1
loop


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/logs/config/indexes/:name

Postman Collection Item JSON

{
  "name": "Get an index",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "logs",
        "config",
        "indexes",
        ":name"
      ],
      "variable": [
        {
          "key": "name",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get one log index from your organization. This endpoint takes no JSON arguments."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes",
            ":name"
          ],
          "variable": [
            {
              "key": "name"
            }
          ]
        }
      },
      "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": "Forbidden",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes",
            ":name"
          ],
          "variable": [
            {
              "key": "name"
            }
          ]
        }
      },
      "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": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes",
            ":name"
          ],
          "variable": [
            {
              "key": "name"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "null"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes",
            ":name"
          ],
          "variable": [
            {
              "key": "name"
            }
          ]
        }
      },
      "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}"
    }
  ]
}