Update REST Incident - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Update REST Incident","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**API Operations on Incident objects. _Check the response section for applicable examples (if any)._**","operationId":"updateRESTIncident","parameters":[{"description":"Unique identifier of the Incident.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : PUT /fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID ( Example of PUT for Incident (change name and status) )":{"value":{"actionTaken":"monitored","equation":{"children":[{"applyCondition":"ANY","children":[{"isRealized":false,"type":"LL_UNSUPPORTED_OBJECT_TYPE|Port","value":"IDREF:{http://hailataxii.com}Observable-fbdadbd3-dc8f-4f21-8736-1123903a056f"}],"condition":"EQUALS","isRealized":false},{"applyCondition":"ANY","children":[{"isRealized":false,"type":"LL_UNSUPPORTED_OBJECT_TYPE|Port","value":"IDREF:{http://hailataxii.com}Observable-ffed4f18-a648-4162-a088-a529f218ff96"}],"condition":"EQUALS","isRealized":false},{"applyCondition":"ANY","children":[{"isRealized":false,"type":"IPV_4_ADDR","value":"ipAddressValue"}],"condition":"EQUALS","isRealized":false},{"applyCondition":"ANY","children":[{"isRealized":true,"type":"DomainNameObjectType","value":"domainNameValue"}],"condition":"EQUALS","isRealized":true}],"isRealized":true,"op":"OR"},"feedId":"feedUUID","id":"incidentUUID","indicatorId":"indicatorUUID","indicatorName":"Test Indicators","name":"Incident","observations":[{"count":1,"data":{"actionTaken":"none","miscData":{"appId":"DNS","clientId":"DNS","connectionSec":"1498739571","counter":"77","destIpAddress":"ipAddressValue","destPort":"53","destZone":"AutomatedInlineSZ","dnsResponse":"No Error","instanceId":"1","protocol":"UDP","srcIpAddress":"ipAddressValue","srcPort":"41207","srcZone":"AutomatedInlineSZ","userId":"No Authentication Required"},"type":"DomainNameObjectType","value":"domainNameValue"},"elementId":"elementUUID","elementName":"elementName","timestamp":1498739571,"type":"observation"}],"property":{"action":"monitor","allowlist":false,"expirationTime":1506514581,"publish":true,"ttl":90},"realizedAt":1498739604,"sourceName":"Test STIX Feed","status":"new","type":"incident","updatedAt":1499839877,"version":"1.0.0"}}},"schema":{"properties":{"actionTaken":{"type":"string"},"description":{"type":"string"},"equation":{"properties":{"applyCondition":{"type":"string"},"children":{"items":{"$ref":"#/components/schemas/RESTIndicatorEquationNode","type":"object"},"type":"array"},"condition":{"type":"string"},"isRealized":{"type":"boolean"},"item":{"properties":{"applyCondition":{"type":"string"},"children":{"items":{"$ref":"#/components/schemas/LLEquationNode","type":"object"},"type":"array"},"condition":{"type":"string"},"isRealized":{"type":"boolean"},"op":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/LLEquationNode"},"op":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/RESTIndicatorEquationNode"},"feedId":{"type":"string"},"id":{"type":"string"},"indicatorId":{"type":"string"},"indicatorName":{"type":"string"},"iteratorId":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"llincident":{"properties":{"actionTaken":{"type":"string"},"description":{"type":"string"},"equation":{"properties":{"applyCondition":{"type":"string"},"children":{"items":{"$ref":"#/components/schemas/LLEquationNode","type":"object"},"type":"array"},"condition":{"type":"string"},"isRealized":{"type":"boolean"},"op":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/LLEquationNode"},"feedId":{"type":"string"},"id":{"type":"string"},"indicatorId":{"type":"string"},"indicatorName":{"type":"string"},"name":{"type":"string"},"observations":{"items":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"data":{"type":"object","properties":{"actionTaken":{"type":"string"},"miscData":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLMiscData"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/LLObservationData"},"elementId":{"type":"string"},"elementName":{"type":"string"},"timestamp":{"format":"int32","type":"integer"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/LLObservation"},"type":"array"},"property":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"publish":{"type":"boolean"},"realizedAt":{"format":"int32","type":"integer"},"sourceName":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"updatedAt":{"format":"int32","type":"integer"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/LLIncident"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"observations":{"items":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"data":{"type":"object","properties":{"actionTaken":{"type":"string"},"llobservationData":{"type":"object","properties":{"actionTaken":{"type":"string"},"miscData":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLMiscData"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/LLObservationData"},"miscData":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLMiscData"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/RESTObservationData"},"elementId":{"type":"string"},"elementName":{"type":"string"},"llobservation":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"data":{"type":"object","properties":{"actionTaken":{"type":"string"},"miscData":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLMiscData"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/LLObservationData"},"elementId":{"type":"string"},"elementName":{"type":"string"},"timestamp":{"format":"int32","type":"integer"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/LLObservation"},"timestamp":{"format":"int32","type":"integer"},"type":{"type":"string"}},"$$ref":"#/components/schemas/RESTObservation"},"type":"array"},"property":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"llfeedProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/RESTFeedProperty"},"realizedAt":{"format":"int32","type":"integer"},"sourceName":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"updatedAt":{"format":"int32","type":"integer"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/RESTIncident"}}},"description":"The input Incident object model.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : PUT /fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID ( Example of PUT for Incident (change name and status) )":{"value":{"actionTaken":"monitored","equation":{"children":[{"applyCondition":"ANY","children":[{"isRealized":false,"type":"LL_UNSUPPORTED_OBJECT_TYPE|Port","value":"IDREF:{http://hailataxii.com}Observable-fbdadbd3-dc8f-4f21-8736-1123903a056f"}],"condition":"EQUALS","isRealized":false},{"applyCondition":"ANY","children":[{"isRealized":false,"type":"LL_UNSUPPORTED_OBJECT_TYPE|Port","value":"IDREF:{http://hailataxii.com}Observable-ffed4f18-a648-4162-a088-a529f218ff96"}],"condition":"EQUALS","isRealized":false},{"applyCondition":"ANY","children":[{"isRealized":false,"type":"IPV_4_ADDR","value":"ipAddressValue"}],"condition":"EQUALS","isRealized":false},{"applyCondition":"ANY","children":[{"isRealized":true,"type":"DomainNameObjectType","value":"domainNameValue"}],"condition":"EQUALS","isRealized":true}],"isRealized":true,"op":"OR"},"feedId":"feedUUID","id":"incidentUUID","indicatorId":"indicatorUUID","indicatorName":"Test Indicators","links":{"self":"/fmc_tid/v1/domain/domainUUID/tid/incident/incidentUUID"},"name":"Incident Closed","observations":[{"count":1,"data":{"actionTaken":"none","miscData":{"appId":"DNS","clientId":"DNS","connectionSec":"1498739571","counter":"77","destIpAddress":"ipAddressValue","destPort":"53","destZone":"AutomatedInlineSZ","dnsResponse":"No Error","instanceId":"1","protocol":"UDP","srcIpAddress":"ipAddressValue","srcPort":"41207","srcZone":"AutomatedInlineSZ","userId":"No Authentication Required"},"type":"DomainNameObjectType","value":"domainNameValue"},"elementId":"elementUUID","elementName":"elementName","timestamp":1498739571,"type":"observation"}],"property":{"action":"monitor","allowlist":false,"expirationTime":1506514581,"publish":true,"ttl":90},"realizedAt":1498739604,"sourceName":"Test STIX Feed","status":"closed","type":"incident","updatedAt":1499840397,"version":"1.0.0"}}},"schema":{"properties":{"actionTaken":{"type":"string"},"description":{"type":"string"},"equation":{"properties":{"applyCondition":{"type":"string"},"children":{"items":{"$ref":"#/components/schemas/RESTIndicatorEquationNode","type":"object"},"type":"array"},"condition":{"type":"string"},"isRealized":{"type":"boolean"},"item":{"properties":{"applyCondition":{"type":"string"},"children":{"items":{"$ref":"#/components/schemas/LLEquationNode","type":"object"},"type":"array"},"condition":{"type":"string"},"isRealized":{"type":"boolean"},"op":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/LLEquationNode"},"op":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/RESTIndicatorEquationNode"},"feedId":{"type":"string"},"id":{"type":"string"},"indicatorId":{"type":"string"},"indicatorName":{"type":"string"},"iteratorId":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"llincident":{"properties":{"actionTaken":{"type":"string"},"description":{"type":"string"},"equation":{"properties":{"applyCondition":{"type":"string"},"children":{"items":{"$ref":"#/components/schemas/LLEquationNode","type":"object"},"type":"array"},"condition":{"type":"string"},"isRealized":{"type":"boolean"},"op":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/LLEquationNode"},"feedId":{"type":"string"},"id":{"type":"string"},"indicatorId":{"type":"string"},"indicatorName":{"type":"string"},"name":{"type":"string"},"observations":{"items":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"data":{"type":"object","properties":{"actionTaken":{"type":"string"},"miscData":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLMiscData"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/LLObservationData"},"elementId":{"type":"string"},"elementName":{"type":"string"},"timestamp":{"format":"int32","type":"integer"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/LLObservation"},"type":"array"},"property":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"publish":{"type":"boolean"},"realizedAt":{"format":"int32","type":"integer"},"sourceName":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"updatedAt":{"format":"int32","type":"integer"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/LLIncident"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"observations":{"items":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"data":{"type":"object","properties":{"actionTaken":{"type":"string"},"llobservationData":{"type":"object","properties":{"actionTaken":{"type":"string"},"miscData":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLMiscData"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/LLObservationData"},"miscData":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLMiscData"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/RESTObservationData"},"elementId":{"type":"string"},"elementName":{"type":"string"},"llobservation":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"data":{"type":"object","properties":{"actionTaken":{"type":"string"},"miscData":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLMiscData"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/LLObservationData"},"elementId":{"type":"string"},"elementName":{"type":"string"},"timestamp":{"format":"int32","type":"integer"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/LLObservation"},"timestamp":{"format":"int32","type":"integer"},"type":{"type":"string"}},"$$ref":"#/components/schemas/RESTObservation"},"type":"array"},"property":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"llfeedProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/RESTFeedProperty"},"realizedAt":{"format":"int32","type":"integer"},"sourceName":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"updatedAt":{"format":"int32","type":"integer"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/RESTIncident"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Intelligence"],"__originalOperationId":"updateRESTIncident","method":"put","path":"/v1/cdfmc/api/fmc_tid/v1/domain/{domainUUID}/tid/incident/{objectId}"}}