Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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": "archives",
# "attributes": {
# "name": "<string>",
# "query": "<string>",
# "destination": {
# "storage_account": "<string>",
# "container": "<string>",
# "integration": {
# "tenant_id": "<string>",
# "client_id": "<string>"
# },
# "type": "azure",
# "path": "<string>",
# "region": "<string>"
# },
# "include_tags": false,
# "rehydration_max_scan_size_in_gb": "<long>",
# "rehydration_tags": [
# "<string>",
# "<string>"
# ]
# }
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("data.type","archives")
json.UpdateString("data.attributes.name","<string>")
json.UpdateString("data.attributes.query","<string>")
json.UpdateString("data.attributes.destination.storage_account","<string>")
json.UpdateString("data.attributes.destination.container","<string>")
json.UpdateString("data.attributes.destination.integration.tenant_id","<string>")
json.UpdateString("data.attributes.destination.integration.client_id","<string>")
json.UpdateString("data.attributes.destination.type","azure")
json.UpdateString("data.attributes.destination.path","<string>")
json.UpdateString("data.attributes.destination.region","<string>")
json.UpdateBool("data.attributes.include_tags",false)
json.UpdateString("data.attributes.rehydration_max_scan_size_in_gb","<long>")
json.UpdateString("data.attributes.rehydration_tags[0]","<string>")
json.UpdateString("data.attributes.rehydration_tags[1]","<string>")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://api.app.ddog-gov.com/api/v2/logs/config/archives","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": {
# "type": "archives",
# "attributes": {
# "name": "<string>",
# "query": "<string>",
# "destination": {
# "storage_account": "<string>",
# "container": "<string>",
# "integration": {
# "tenant_id": "<string>",
# "client_id": "<string>"
# },
# "type": "azure",
# "path": "<string>",
# "region": "<string>"
# },
# "include_tags": false,
# "rehydration_max_scan_size_in_gb": "<long>",
# "rehydration_tags": [
# "<string>",
# "<string>"
# ],
# "state": "FAILING"
# },
# "id": "<string>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
v_Type = jResp.stringOf("data.type")
Name = jResp.stringOf("data.attributes.name")
Query = jResp.stringOf("data.attributes.query")
Storage_account = jResp.stringOf("data.attributes.destination.storage_account")
Container = jResp.stringOf("data.attributes.destination.container")
Tenant_id = jResp.stringOf("data.attributes.destination.integration.tenant_id")
Client_id = jResp.stringOf("data.attributes.destination.integration.client_id")
DestinationType = jResp.stringOf("data.attributes.destination.type")
Path = jResp.stringOf("data.attributes.destination.path")
Region = jResp.stringOf("data.attributes.destination.region")
Include_tags = jResp.BoolOf("data.attributes.include_tags")
Rehydration_max_scan_size_in_gb = jResp.stringOf("data.attributes.rehydration_max_scan_size_in_gb")
State = jResp.stringOf("data.attributes.state")
Id = jResp.stringOf("data.id")
i = 0
count_i = jResp.SizeOfArray("data.attributes.rehydration_tags")
while i < count_i
jResp.put_I(i)
strVal = jResp.stringOf("data.attributes.rehydration_tags[i]")
i = i + 1
end
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "archives",
"attributes": {
"name": "<string>",
"query": "<string>",
"destination": {
"storage_account": "<string>",
"container": "<string>",
"integration": {
"tenant_id": "<string>",
"client_id": "<string>"
},
"type": "azure",
"path": "<string>",
"region": "<string>"
},
"include_tags": false,
"rehydration_max_scan_size_in_gb": "<long>",
"rehydration_tags": [
"<string>",
"<string>"
]
}
}
}'
https://api.app.ddog-gov.com/api/v2/logs/config/archives
Postman Collection Item JSON
{
"name": "Create an archive",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"destination\": {\n \"storage_account\": \"<string>\",\n \"container\": \"<string>\",\n \"integration\": {\n \"tenant_id\": \"<string>\",\n \"client_id\": \"<string>\"\n },\n \"type\": \"azure\",\n \"path\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": \"<long>\",\n \"rehydration_tags\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
},
"description": "Create an archive in your organization."
},
"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\": \"archives\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"destination\": {\n \"storage_account\": \"<string>\",\n \"container\": \"<string>\",\n \"integration\": {\n \"tenant_id\": \"<string>\",\n \"client_id\": \"<string>\"\n },\n \"type\": \"azure\",\n \"path\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": \"<long>\",\n \"rehydration_tags\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"destination\": {\n \"storage_account\": \"<string>\",\n \"container\": \"<string>\",\n \"integration\": {\n \"tenant_id\": \"<string>\",\n \"client_id\": \"<string>\"\n },\n \"type\": \"azure\",\n \"path\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": \"<long>\",\n \"rehydration_tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"state\": \"FAILING\"\n },\n \"id\": \"<string>\"\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\": \"archives\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"destination\": {\n \"storage_account\": \"<string>\",\n \"container\": \"<string>\",\n \"integration\": {\n \"tenant_id\": \"<string>\",\n \"client_id\": \"<string>\"\n },\n \"type\": \"azure\",\n \"path\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": \"<long>\",\n \"rehydration_tags\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"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": "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 \"data\": {\n \"type\": \"archives\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"destination\": {\n \"storage_account\": \"<string>\",\n \"container\": \"<string>\",\n \"integration\": {\n \"tenant_id\": \"<string>\",\n \"client_id\": \"<string>\"\n },\n \"type\": \"azure\",\n \"path\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": \"<long>\",\n \"rehydration_tags\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"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\": \"archives\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"query\": \"<string>\",\n \"destination\": {\n \"storage_account\": \"<string>\",\n \"container\": \"<string>\",\n \"integration\": {\n \"tenant_id\": \"<string>\",\n \"client_id\": \"<string>\"\n },\n \"type\": \"azure\",\n \"path\": \"<string>\",\n \"region\": \"<string>\"\n },\n \"include_tags\": false,\n \"rehydration_max_scan_size_in_gb\": \"<long>\",\n \"rehydration_tags\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/logs/config/archives",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"logs",
"config",
"archives"
]
}
},
"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}"
}
]
}
