Swift / Datadog API Collection / Change the related incidents of a security signal
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
// 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": {
// "attributes": {
// "incident_ids": [
// "<long>",
// "<long>"
// ],
// "version": "<long>"
// }
// }
// }
let json = CkoJsonObject()
json.UpdateString("data.attributes.incident_ids[0]", value: "<long>")
json.UpdateString("data.attributes.incident_ids[1]", value: "<long>")
json.UpdateString("data.attributes.version", value: "<long>")
http.SetRequestHeader("Content-Type", value: "application/json")
http.SetRequestHeader("Accept", value: "application/json")
let sbRequestBody = CkoStringBuilder()
json.EmitSb(sbRequestBody)
var resp: CkoHttpResponse? = http.PTextSb("PATCH", url: "https://api.app.ddog-gov.com/api/v2/security_monitoring/signals/:signal_id/incidents", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
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": {
// "assignee": {
// "uuid": "<string>",
// "handle": "<string>",
// "icon": "<string>",
// "id": "<long>",
// "name": "<string>"
// },
// "state": "open",
// "incident_ids": [
// "<long>",
// "<long>"
// ],
// "archive_comment": "<string>",
// "archive_comment_timestamp": "<long>",
// "archive_comment_user": {
// "uuid": "<string>",
// "handle": "<string>",
// "icon": "<string>",
// "id": "<long>",
// "name": "<string>"
// },
// "archive_reason": "other",
// "state_update_timestamp": "<long>",
// "state_update_user": {
// "uuid": "<string>",
// "handle": "<string>",
// "icon": "<string>",
// "id": "<long>",
// "name": "<string>"
// }
// },
// "id": "<string>",
// "type": "signal_metadata"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var strVal: String?
var Uuid: String? = jResp.StringOf("data.attributes.assignee.uuid")
var Handle: String? = jResp.StringOf("data.attributes.assignee.handle")
var Icon: String? = jResp.StringOf("data.attributes.assignee.icon")
var Id: String? = jResp.StringOf("data.attributes.assignee.id")
var Name: String? = jResp.StringOf("data.attributes.assignee.name")
var State: String? = jResp.StringOf("data.attributes.state")
var Archive_comment: String? = jResp.StringOf("data.attributes.archive_comment")
var Archive_comment_timestamp: String? = jResp.StringOf("data.attributes.archive_comment_timestamp")
var Archive_comment_userUuid: String? = jResp.StringOf("data.attributes.archive_comment_user.uuid")
var Archive_comment_userHandle: String? = jResp.StringOf("data.attributes.archive_comment_user.handle")
var Archive_comment_userIcon: String? = jResp.StringOf("data.attributes.archive_comment_user.icon")
var Archive_comment_userId: String? = jResp.StringOf("data.attributes.archive_comment_user.id")
var Archive_comment_userName: String? = jResp.StringOf("data.attributes.archive_comment_user.name")
var Archive_reason: String? = jResp.StringOf("data.attributes.archive_reason")
var State_update_timestamp: String? = jResp.StringOf("data.attributes.state_update_timestamp")
var State_update_userUuid: String? = jResp.StringOf("data.attributes.state_update_user.uuid")
var State_update_userHandle: String? = jResp.StringOf("data.attributes.state_update_user.handle")
var State_update_userIcon: String? = jResp.StringOf("data.attributes.state_update_user.icon")
var State_update_userId: String? = jResp.StringOf("data.attributes.state_update_user.id")
var State_update_userName: String? = jResp.StringOf("data.attributes.state_update_user.name")
var dataId: String? = jResp.StringOf("data.id")
var v_Type: String? = jResp.StringOf("data.type")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("data.attributes.incident_ids").intValue
while i < count_i {
jResp.I = i
strVal = jResp.StringOf("data.attributes.incident_ids[i]")
i = i + 1
}
}
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"incident_ids": [
"<long>",
"<long>"
],
"version": "<long>"
}
}
}'
https://api.app.ddog-gov.com/api/v2/security_monitoring/signals/:signal_id/incidents
Postman Collection Item JSON
{
"name": "Change the related incidents of a security signal",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"incident_ids\": [\n \"<long>\",\n \"<long>\"\n ],\n \"version\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id",
"value": "<string>"
}
]
},
"description": "Change the related incidents for a security signal."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"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 \"attributes\": {\n \"incident_ids\": [\n \"<long>\",\n \"<long>\"\n ],\n \"version\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"assignee\": {\n \"uuid\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"id\": \"<long>\",\n \"name\": \"<string>\"\n },\n \"state\": \"open\",\n \"incident_ids\": [\n \"<long>\",\n \"<long>\"\n ],\n \"archive_comment\": \"<string>\",\n \"archive_comment_timestamp\": \"<long>\",\n \"archive_comment_user\": {\n \"uuid\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"id\": \"<long>\",\n \"name\": \"<string>\"\n },\n \"archive_reason\": \"other\",\n \"state_update_timestamp\": \"<long>\",\n \"state_update_user\": {\n \"uuid\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"id\": \"<long>\",\n \"name\": \"<string>\"\n }\n },\n \"id\": \"<string>\",\n \"type\": \"signal_metadata\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"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 \"attributes\": {\n \"incident_ids\": [\n \"<long>\",\n \"<long>\"\n ],\n \"version\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"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": "PATCH",
"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 \"attributes\": {\n \"incident_ids\": [\n \"<long>\",\n \"<long>\"\n ],\n \"version\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"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": "Not Found",
"originalRequest": {
"method": "PATCH",
"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 \"attributes\": {\n \"incident_ids\": [\n \"<long>\",\n \"<long>\"\n ],\n \"version\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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": "PATCH",
"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 \"attributes\": {\n \"incident_ids\": [\n \"<long>\",\n \"<long>\"\n ],\n \"version\": \"<long>\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/signals/:signal_id/incidents",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"signals",
":signal_id",
"incidents"
],
"variable": [
{
"key": "signal_id"
}
]
}
},
"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}"
}
]
}
