PowerBuilder / Datadog API Collection / Get a quick list of security signals
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Message
string ls_Timestamp
string ls_Id
string ls_V_type
integer j
integer li_Count_j
string ls_StrVal
string ls_V_Next
string ls_After
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
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("filter[query]","<string>")
loo_QueryParams.UpdateString("filter[from]","<dateTime>")
loo_QueryParams.UpdateString("filter[to]","<dateTime>")
loo_QueryParams.UpdateString("sort","-timestamp")
loo_QueryParams.UpdateString("page[cursor]","<string>")
loo_QueryParams.UpdateInt("page[limit]",10)
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/security_monitoring/signals",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "attributes": {
// "attributes": {
// "laboris6b": {},
// "qui_4_": {},
// "sintcb": {}
// },
// "message": "<string>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "timestamp": "<dateTime>"
// },
// "id": "<string>",
// "type": "signal"
// },
// {
// "attributes": {
// "attributes": {
// "cillumc": {},
// "ut_75": {}
// },
// "message": "<string>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "timestamp": "<dateTime>",
// "sit5": {}
// },
// "id": "<string>",
// "type": "signal"
// }
// ],
// "links": {
// "next": "<string>"
// },
// "meta": {
// "page": {
// "after": "<string>"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_V_Next = loo_JResp.StringOf("links.next")
ls_After = loo_JResp.StringOf("meta.page.after")
i = 0
li_Count_i = loo_JResp.SizeOfArray("data")
do while i < li_Count_i
loo_JResp.I = i
ls_Message = loo_JResp.StringOf("data[i].attributes.message")
ls_Timestamp = loo_JResp.StringOf("data[i].attributes.timestamp")
ls_Id = loo_JResp.StringOf("data[i].id")
ls_V_type = loo_JResp.StringOf("data[i].type")
j = 0
li_Count_j = loo_JResp.SizeOfArray("data[i].attributes.tags")
do while j < li_Count_j
loo_JResp.J = j
ls_StrVal = loo_JResp.StringOf("data[i].attributes.tags[j]")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -G -d "filter[query]=%3Cstring%3E"
-d "filter[from]=%3CdateTime%3E"
-d "filter[to]=%3CdateTime%3E"
-d "sort=-timestamp"
-d "page[cursor]=%3Cstring%3E"
-d "page[limit]=10"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/security_monitoring/signals
Postman Collection Item JSON
{
"name": "Get a quick list of security signals",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "The search query for security signals."
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "The minimum timestamp for requested security signals."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "The maximum timestamp for requested security signals."
},
{
"key": "sort",
"value": "-timestamp",
"description": "The order of the security signals in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "A list of results using the cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "The maximum number of security signals in the response."
}
]
},
"description": "The list endpoint returns security signals that match a search query.\nBoth this endpoint and the POST endpoint can be used interchangeably when listing\nsecurity signals."
},
"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/v2/security_monitoring/signals?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "The search query for security signals."
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "The minimum timestamp for requested security signals."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "The maximum timestamp for requested security signals."
},
{
"key": "sort",
"value": "-timestamp",
"description": "The order of the security signals in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "A list of results using the cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "The maximum number of security signals in the response."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"attributes\": {\n \"laboris6b\": {},\n \"qui_4_\": {},\n \"sintcb\": {}\n },\n \"message\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"timestamp\": \"<dateTime>\"\n },\n \"id\": \"<string>\",\n \"type\": \"signal\"\n },\n {\n \"attributes\": {\n \"attributes\": {\n \"cillumc\": {},\n \"ut_75\": {}\n },\n \"message\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"timestamp\": \"<dateTime>\",\n \"sit5\": {}\n },\n \"id\": \"<string>\",\n \"type\": \"signal\"\n }\n ],\n \"links\": {\n \"next\": \"<string>\"\n },\n \"meta\": {\n \"page\": {\n \"after\": \"<string>\"\n }\n }\n}"
},
{
"name": "Bad Request",
"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/v2/security_monitoring/signals?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "The search query for security signals."
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "The minimum timestamp for requested security signals."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "The maximum timestamp for requested security signals."
},
{
"key": "sort",
"value": "-timestamp",
"description": "The order of the security signals in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "A list of results using the cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "The maximum number of security signals in the response."
}
]
}
},
"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": "Not Authorized",
"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/v2/security_monitoring/signals?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "The search query for security signals."
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "The minimum timestamp for requested security signals."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "The maximum timestamp for requested security signals."
},
{
"key": "sort",
"value": "-timestamp",
"description": "The order of the security signals in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "A list of results using the cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "The maximum number of security signals in the response."
}
]
}
},
"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": "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/v2/security_monitoring/signals?filter[query]=<string>&filter[from]=<dateTime>&filter[to]=<dateTime>&sort=-timestamp&page[cursor]=<string>&page[limit]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals"
],
"query": [
{
"key": "filter[query]",
"value": "<string>",
"description": "The search query for security signals."
},
{
"key": "filter[from]",
"value": "<dateTime>",
"description": "The minimum timestamp for requested security signals."
},
{
"key": "filter[to]",
"value": "<dateTime>",
"description": "The maximum timestamp for requested security signals."
},
{
"key": "sort",
"value": "-timestamp",
"description": "The order of the security signals in results."
},
{
"key": "page[cursor]",
"value": "<string>",
"description": "A list of results using the cursor provided in the previous query."
},
{
"key": "page[limit]",
"value": "10",
"description": "The maximum number of security signals in the response."
}
]
}
},
"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}"
}
]
}
