Create Overlap Warning - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Overlap Warning","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":"**Get overlaps for the given network objects/literals and port objects/literals. _Check the response section for applicable examples (if any)._**","operationId":"createOverlapWarning","parameters":[{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full overlaps between objects/literals for networks )":{"value":{"networks":{"literals":[{"type":"Host","value":"1.1.1.1"},{"type":"Network","value":"1.1.1.0/24"}],"objects":[{"id":"cb7116e8-66a6-480b-8f9b-295191a0940a","name":"any-ipv4","type":"Network"}]},"ports":{"literals":[],"objects":[]}}},"Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full overlaps between objects/literals for ports )":{"value":{"networks":{"literals":[],"objects":[]},"ports":{"literals":[{"port":"80","protocol":"6","type":"PortLiteral"}],"objects":[{"id":"18312adc-38bb-11e2-86aa-62f0c593a59a","name":"HTTP","type":"ProtocolPortObject"},{"id":"1834bd00-38bb-11e2-86aa-62f0c593a59a","name":"HTTPS","type":"ProtocolPortObject"},{"id":"0050568A-9CA9-0ed3-0000-038654705760","name":"portObj","type":"ProtocolPortObject"}]}}},"Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full overlaps between objects/literals for network and ports both )":{"value":{"networks":{"literals":[{"type":"Host","value":"1.1.1.1"},{"type":"Network","value":"1.1.1.0/24"}],"objects":[{"id":"cb7116e8-66a6-480b-8f9b-295191a0940a","name":"any-ipv4","type":"Network"}]},"ports":{"literals":[{"port":"80","protocol":"6","type":"PortLiteral"}],"objects":[{"id":"18312adc-38bb-11e2-86aa-62f0c593a59a","name":"HTTP","type":"ProtocolPortObject"},{"id":"1834bd00-38bb-11e2-86aa-62f0c593a59a","name":"HTTPS","type":"ProtocolPortObject"}]}}}},"schema":{"properties":{"description":{"type":"string"},"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"},"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"},"networks":{"properties":{"literals":{"items":{"properties":{"overlapType":{"enum":["PARTIAL","FULL"],"type":"string"},"overlappingLiterals":{"items":{"$ref":"#/components/schemas/NetworkLiteralOverlaps","type":"object"},"type":"array"},"overlappingObjects":{"items":{"$ref":"#/components/schemas/NetworkObjectOverlaps","type":"object"},"type":"array"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/NetworkLiteralOverlaps"},"type":"array"},"objects":{"items":{"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"},"overlapType":{"enum":["PARTIAL","FULL"],"type":"string"},"overlappingLiterals":{"items":{"$ref":"#/components/schemas/NetworkLiteralOverlaps","type":"object"},"type":"array"},"overlappingObjects":{"items":{"$ref":"#/components/schemas/NetworkObjectOverlaps","type":"object"},"type":"array"},"type":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/NetworkObjectOverlaps"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/NetworkOverlapsContainer"},"ports":{"properties":{"literals":{"items":{"properties":{"overlapType":{"enum":["PARTIAL","FULL"],"type":"string"},"overlappingLiterals":{"items":{"$ref":"#/components/schemas/PortLiteralOverlaps","type":"object"},"type":"array"},"overlappingObjects":{"items":{"$ref":"#/components/schemas/PortObjectOverlaps","type":"object"},"type":"array"},"port":{"type":"string"},"protocol":{"type":"string"},"type":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/PortLiteralOverlaps"},"type":"array"},"objects":{"items":{"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"},"overlapType":{"enum":["PARTIAL","FULL"],"type":"string"},"overlappingLiterals":{"items":{"$ref":"#/components/schemas/PortLiteralOverlaps","type":"object"},"type":"array"},"overlappingObjects":{"items":{"$ref":"#/components/schemas/PortObjectOverlaps","type":"object"},"type":"array"},"protocol":{"type":"string"},"type":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/PortObjectOverlaps"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/PortOverlapsContainer"},"type":{"type":"string"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/OverlapWarning"}}},"description":"Input representation of networks and ports.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full overlaps between objects/literals for networks )":{"value":{"networks":{"literals":[{"overlappingLiterals":[{"overlapType":"FULL","value":"1.1.1.0/24"}],"overlappingObjects":[{"id":"cb7116e8-66a6-480b-8f9b-295191a0940a","name":"any-ipv4","overlapType":"FULL","type":"Network"}],"type":"Host","value":"1.1.1.1"},{"overlappingObjects":[{"id":"cb7116e8-66a6-480b-8f9b-295191a0940a","name":"any-ipv4","overlapType":"FULL","type":"Network"}],"type":"Network","value":"1.1.1.0/24"}]},"ports":{}}},"Example 2 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full overlaps between objects/literals for ports )":{"value":{"networks":{},"ports":{"literals":[{"overlappingObjects":[{"id":"0050568A-9CA9-0ed3-0000-038654705760","name":"portObj","overlapType":"FULL","type":"ProtocolPortObject"}],"port":"80","protocol":"6","type":"PortLiteral"}],"objects":[{"id":"18312adc-38bb-11e2-86aa-62f0c593a59a","name":"HTTP","overlappingLiterals":[{"overlapType":"FULL","port":"80","protocol":"6","type":"PortLiteral"}],"overlappingObjects":[{"id":"0050568A-9CA9-0ed3-0000-038654705760","name":"portObj","overlapType":"FULL","type":"ProtocolPortObject"}],"type":"ProtocolPortObject"}]}}},"Example 3 : POST /fmc_config/v1/domain/DomainUUID/object/operational/findoverlaps ( Fetch partial and full overlaps between objects/literals for network and ports both )":{"value":{"networks":{"literals":[{"overlappingLiterals":[{"overlapType":"FULL","value":"1.1.1.0/24"}],"overlappingObjects":[{"id":"cb7116e8-66a6-480b-8f9b-295191a0940a","name":"any-ipv4","overlapType":"FULL","type":"Network"}],"type":"Host","value":"1.1.1.1"},{"overlappingObjects":[{"id":"cb7116e8-66a6-480b-8f9b-295191a0940a","name":"any-ipv4","overlapType":"FULL","type":"Network"}],"type":"Network","value":"1.1.1.0/24"}]},"ports":{"objects":[{"id":"18312adc-38bb-11e2-86aa-62f0c593a59a","name":"HTTP","overlappingLiterals":[{"overlapType":"FULL","port":"80","protocol":"6","type":"PortLiteral"}],"type":"ProtocolPortObject"}]}}}},"schema":{"properties":{"description":{"type":"string"},"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"},"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"},"networks":{"properties":{"literals":{"items":{"properties":{"overlapType":{"enum":["PARTIAL","FULL"],"type":"string"},"overlappingLiterals":{"items":{"$ref":"#/components/schemas/NetworkLiteralOverlaps","type":"object"},"type":"array"},"overlappingObjects":{"items":{"$ref":"#/components/schemas/NetworkObjectOverlaps","type":"object"},"type":"array"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/NetworkLiteralOverlaps"},"type":"array"},"objects":{"items":{"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"},"overlapType":{"enum":["PARTIAL","FULL"],"type":"string"},"overlappingLiterals":{"items":{"$ref":"#/components/schemas/NetworkLiteralOverlaps","type":"object"},"type":"array"},"overlappingObjects":{"items":{"$ref":"#/components/schemas/NetworkObjectOverlaps","type":"object"},"type":"array"},"type":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/NetworkObjectOverlaps"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/NetworkOverlapsContainer"},"ports":{"properties":{"literals":{"items":{"properties":{"overlapType":{"enum":["PARTIAL","FULL"],"type":"string"},"overlappingLiterals":{"items":{"$ref":"#/components/schemas/PortLiteralOverlaps","type":"object"},"type":"array"},"overlappingObjects":{"items":{"$ref":"#/components/schemas/PortObjectOverlaps","type":"object"},"type":"array"},"port":{"type":"string"},"protocol":{"type":"string"},"type":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/PortLiteralOverlaps"},"type":"array"},"objects":{"items":{"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"},"overlapType":{"enum":["PARTIAL","FULL"],"type":"string"},"overlappingLiterals":{"items":{"$ref":"#/components/schemas/PortLiteralOverlaps","type":"object"},"type":"array"},"overlappingObjects":{"items":{"$ref":"#/components/schemas/PortObjectOverlaps","type":"object"},"type":"array"},"protocol":{"type":"string"},"type":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/PortObjectOverlaps"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/PortOverlapsContainer"},"type":{"type":"string"},"version":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/OverlapWarning"}}},"description":"Created"},"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":["Object"],"__originalOperationId":"createOverlapWarning","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/operational/findoverlaps"}}