Get NAT policy analysis rule conflicts - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get NAT policy analysis rule conflicts","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/241e37f202cf9838405f7ca5ed9f7d31d807d7bd/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.22.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"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.uae.security.cisco.com/firewall","description":"UAE"},{"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://devfed.cdo.cisco.com/api/rest","description":"Devfed"},{"url":"https://manage.dev.secure.cisco/api/rest","description":"Devf9"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"},{"url":"https://manage.secure.cisco/api/rest","description":"ProdF9"},{"url":"https://manage.securitydod.cisco/api/rest","description":"IL5"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Gets rule-level conflict data for the specified NAT policy analysis. Each item includes the `hasShadowedRules` and `hasRedundantRules` fields, which indicate whether the conflicting rules are shadowed or redundant, respectively. If there are no conflicts, an empty page is returned.","operationId":"getNatPolicyRuleConflicts","parameters":[{"description":"Number of results to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":"50","maximum":200,"minimum":0,"type":"string"}},{"description":"Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","in":"query","name":"offset","required":false,"schema":{"default":"0","minimum":0,"type":"string"}},{"description":"The unique identifier of the NAT policy analysis.","example":"a276b855-feb7-4774-863f-569f2826f3f5","in":"path","name":"insightsUid","required":true,"schema":{"type":"string"}},{"description":"Filter results to conflicts containing shadowed rules.","in":"query","name":"shadowedOnly","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Filter results to conflicts containing redundant rules.","in":"query","name":"redundantOnly","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results available.","example":100,"format":"int32","type":"integer"},"items":{"description":"The list of items retrieved.","items":{"description":"Rule Conflicts Data holding original rule and conflicting rules.","properties":{"conflictingRules":{"description":"The Data of the conflicting rules.","properties":{"redundantRules":{"items":{"properties":{"destinationInterface":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"direction":{"enum":["UNIDIRECTIONAL","BIDIRECTIONAL"],"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"originalDestination":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"originalDestinationPort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"originalSource":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"originalSourcePort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"ruleIndex":{"format":"int32","type":"integer"},"ruleName":{"type":"string"},"ruleSection":{"enum":["NAT_RULES_BEFORE","NAT_RULES_AFTER","AUTO_NAT"],"type":"string"},"ruleType":{"enum":["STATIC","DYNAMIC"],"type":"string"},"sourceInterface":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedDestination":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedDestinationPort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedSource":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedSourcePort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"}},"type":"object","$$ref":"#/components/schemas/ExtendedNatRuleData"},"type":"array"},"shadowedRules":{"items":{"properties":{"destinationInterface":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"direction":{"enum":["UNIDIRECTIONAL","BIDIRECTIONAL"],"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"originalDestination":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"originalDestinationPort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"originalSource":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"originalSourcePort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"ruleIndex":{"format":"int32","type":"integer"},"ruleName":{"type":"string"},"ruleSection":{"enum":["NAT_RULES_BEFORE","NAT_RULES_AFTER","AUTO_NAT"],"type":"string"},"ruleType":{"enum":["STATIC","DYNAMIC"],"type":"string"},"sourceInterface":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedDestination":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedDestinationPort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedSource":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedSourcePort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"}},"type":"object","$$ref":"#/components/schemas/ExtendedNatRuleData"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/ConflictingRules"},"isRedundant":{"description":"Are the conflicting rules redundant rules.","type":"boolean"},"isShadowed":{"description":"Are the conflicting rules shadowed rules.","type":"boolean"},"observationId":{"description":"Rule conflict observation identifier.","type":"string"},"originalRule":{"description":"The Data of the Original rule.","properties":{"destinationInterface":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"direction":{"enum":["UNIDIRECTIONAL","BIDIRECTIONAL"],"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"originalDestination":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"originalDestinationPort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"originalSource":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"originalSourcePort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"ruleIndex":{"format":"int32","type":"integer"},"ruleName":{"type":"string"},"ruleSection":{"enum":["NAT_RULES_BEFORE","NAT_RULES_AFTER","AUTO_NAT"],"type":"string"},"ruleType":{"enum":["STATIC","DYNAMIC"],"type":"string"},"sourceInterface":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedDestination":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedDestinationPort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedSource":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"translatedSourcePort":{"properties":{"name":{"type":"string"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/ObjectData"},"type":{"description":"Type of the rule.","example":"ManualNat64Rule","type":"string"},"uid":{"description":"UID of the rule.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"}},"type":"object","$$ref":"#/components/schemas/originalRule"}},"type":"object","$$ref":"#/components/schemas/RuleConflictsData"},"type":"array"},"limit":{"description":"The number of results retrieved.","example":50,"format":"int32","type":"integer"},"offset":{"description":"The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","example":0,"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/RuleConflictsDataPage"}}},"description":"Paginated list of NAT policy analysis rule conflicts"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"type":"object","$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Entity not found.","$$ref":"#/components/responses/http404NotFound"},"405":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Method not allowed.","$$ref":"#/components/responses/http405MethodNotAllowed"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get NAT policy analysis rule conflicts","tags":["Policy Analysis and Optimization"],"__originalOperationId":"getNatPolicyRuleConflicts","method":"get","path":"/v1/agenticops/policies/nat/analysis/insights/{insightsUid}/details"}}