Chilkat Online Tools

phpExt / Datadog API Collection / Update an index

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

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

// The following JSON is sent in the request body.

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

$json = new CkJsonObject();
$json->UpdateString('filter.query','source:python');
$json->UpdateInt('daily_limit',300000000);
$json->UpdateBool('disable_daily_limit',false);
$json->UpdateString('exclusion_filters[0].name','payment');
$json->UpdateInt('exclusion_filters[0].filter.sample_rate',1);
$json->UpdateString('exclusion_filters[0].filter.query','*');
$json->UpdateBool('exclusion_filters[0].is_enabled',false);
$json->UpdateString('exclusion_filters[1].name','payment');
$json->UpdateInt('exclusion_filters[1].filter.sample_rate',1);
$json->UpdateString('exclusion_filters[1].filter.query','*');
$json->UpdateBool('exclusion_filters[1].is_enabled',true);
$json->UpdateInt('num_retention_days',15);

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept','application/json');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://api.app.ddog-gov.com/api/v1/logs/config/indexes/:name',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

$name = $jResp->stringOf('name');
$Query = $jResp->stringOf('filter.query');
$daily_limit = $jResp->IntOf('daily_limit');
$is_rate_limited = $jResp->BoolOf('is_rate_limited');
$num_retention_days = $jResp->IntOf('num_retention_days');
$i = 0;
$count_i = $jResp->SizeOfArray('exclusion_filters');
while ($i < $count_i) {
    $jResp->put_I($i);
    $name = $jResp->stringOf('exclusion_filters[i].name');
    $Sample_rate = $jResp->IntOf('exclusion_filters[i].filter.sample_rate');
    $filterQuery = $jResp->stringOf('exclusion_filters[i].filter.query');
    $is_enabled = $jResp->BoolOf('exclusion_filters[i].is_enabled');
    $i = $i + 1;
}


?>

Curl Command

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

Postman Collection Item JSON

{
  "name": "Update an index",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"disable_daily_limit\": false,\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  \"num_retention_days\": 15\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "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": "Update an index as identified by its name.\nReturns the Index object passed in the request body when the request is successful.\n\nUsing the `PUT` method updates your index’s configuration by **replacing**\nyour current configuration with the new one sent to your Datadog organization."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "PUT",
        "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  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"disable_daily_limit\": false,\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  \"num_retention_days\": 15\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "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": "Invalid Parameter Error",
      "originalRequest": {
        "method": "PUT",
        "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  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"disable_daily_limit\": false,\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  \"num_retention_days\": 15\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "logs",
            "config",
            "indexes",
            ":name"
          ],
          "variable": [
            {
              "key": "name"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "null"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "PUT",
        "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  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"disable_daily_limit\": false,\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  \"num_retention_days\": 15\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "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": "Too Many Requests",
      "originalRequest": {
        "method": "PUT",
        "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  \"filter\": {\n    \"query\": \"source:python\"\n  },\n  \"daily_limit\": 300000000,\n  \"disable_daily_limit\": false,\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  \"num_retention_days\": 15\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "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": "null"
    }
  ]
}