Swift3 / Datadog API Collection / Get a quick list of security signals
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
let queryParams = CkoJsonObject()!
queryParams.update("filter[query]", value: "<string>")
queryParams.update("filter[from]", value: "<dateTime>")
queryParams.update("filter[to]", value: "<dateTime>")
queryParams.update("sort", value: "-timestamp")
queryParams.update("page[cursor]", value: "<string>")
queryParams.updateInt("page[limit]", value: 10)
http.setRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.app.ddog-gov.com/api/v2/security_monitoring/signals", json: queryParams)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var Message: String?
var Timestamp: String?
var id: String?
var v_type: String?
var j: Int
var count_j: Int
var strVal: String?
var v_Next: String? = jResp.string(of: "links.next")
var After: String? = jResp.string(of: "meta.page.after")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "data").intValue
while i < count_i {
jResp.i = i
Message = jResp.string(of: "data[i].attributes.message")
Timestamp = jResp.string(of: "data[i].attributes.timestamp")
id = jResp.string(of: "data[i].id")
v_type = jResp.string(of: "data[i].type")
j = 0
count_j = jResp.size(ofArray: "data[i].attributes.tags").intValue
while j < count_j {
jResp.j = j
strVal = jResp.string(of: "data[i].attributes.tags[j]")
j = j + 1
}
i = i + 1
}
}
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}"
}
]
}
