Objective-C / Datadog API Collection / Get a quick list of security signals
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"filter[query]" value: @"<string>"];
[queryParams UpdateString: @"filter[from]" value: @"<dateTime>"];
[queryParams UpdateString: @"filter[to]" value: @"<dateTime>"];
[queryParams UpdateString: @"sort" value: @"-timestamp"];
[queryParams UpdateString: @"page[cursor]" value: @"<string>"];
[queryParams UpdateInt: @"page[limit]" value: [NSNumber numberWithInt: 10]];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.app.ddog-gov.com/api/v2/security_monitoring/signals" json: queryParams];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *Message = 0;
NSString *Timestamp = 0;
NSString *id = 0;
NSString *v_type = 0;
int j;
int count_j;
NSString *strVal = 0;
NSString *v_Next = [jResp StringOf: @"links.next"];
NSString *After = [jResp StringOf: @"meta.page.after"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
Message = [jResp StringOf: @"data[i].attributes.message"];
Timestamp = [jResp StringOf: @"data[i].attributes.timestamp"];
id = [jResp StringOf: @"data[i].id"];
v_type = [jResp StringOf: @"data[i].type"];
j = 0;
count_j = [[jResp SizeOfArray: @"data[i].attributes.tags"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
strVal = [jResp StringOf: @"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}"
}
]
}
