openapi: 3.2.0 info: title: Cisco Secure Firewall Policy API version: '1.0' description: 'Operations tagged Policy across 3 of this provider''s published API definitions: cdfmc-openapi.yaml, cisco-secure-firewall-cdfmc-openapi.yml, cisco-secure-firewall-scc-mesh-policy-openapi.json. Each path carries the servers of the definition it was published in.' x-provenance: method: harvested first_party: true harvested: '2026-08-19' source: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/cdo/cdfmc-openapi.yaml source_repo: https://github.com/CiscoDevNet/scc-public-api-docs note: Verbatim first-party OpenAPI published by Cisco in the CiscoDevNet scc-public-api-docs repository, the source of record for developer.cisco.com/docs/cisco-security-cloud-control-firewall-manager/. Not authored or modified by API Evangelist. derived_view: Per-tag view of cisco-secure-firewall-cdfmc-openapi.yml, the provider's source document. Operations and schemas are the provider's, unmodified; only the partition is ours. derived_from: cisco-secure-firewall-cdfmc-openapi.yml operation_coverage: 328/332 x-evidence: fetched: '2026-08-19' url: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/cdo/cdfmc-openapi.yaml http_status: 200 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 - url: https://api.security.cisco.com/pinacl/api tags: - name: Policy paths: /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies: get: deprecated: false description: '**Get the list of all access control policies.**' operationId: getAllAccessPolicy parameters: - description: Only show the policy matching the specified name. in: query name: name required: false schema: type: string - description: 'Value is of format (including quotes): "locked:{true|false}"
lockedquery parameter when set to ''true'' returns list of Access Policies which are locked and when set to ''false'' returns policies which are unlocked.' in: query name: filter required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies ( Test GET ALL Success of AccessPolicy policy )': value: items: - defaultAction: id: id_of_default_action type: AccessPolicyDefaultAction description: policy to test FMC implementation name: AccessPolicy1_updated type: AccessPolicy - defaultAction: id: id_of_default_action type: AccessPolicyDefaultAction description: policy to test FMC implementation name: AccessPolicy2_updated type: AccessPolicy links: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies?offset=0&limit=2 schema: $ref: '#/components/schemas/AccessPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create an access control policy. _Check the response section for applicable examples (if any)._**' operationId: createAccessPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies ( Success: POST method for AccessPolicy with minimum required fields )' : value: defaultAction: action: BLOCK name: AccessPolicy1 type: AccessPolicy 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies ( Success: Test POST method for AccessPolicy )': value: defaultAction: action: any_allowed_action_enum intrusionPolicy: id: id_of_existing_or_new_intrusion_policy type: IntrusionPolicy logBegin: true/false logEnd: true/false sendEventsToFMC: true/false snmpConfig: id: id_of_snmpConfig_object type: SNMPAlert syslogConfig: id: id_of_syslog_object type: SyslogAlert type: AccessPolicyDefaultAction variableSet: id: id_of_variableSet_to_be_added type: VariableSet description: policy to test FMC implementation name: AccessPolicy1 type: AccessPolicy schema: $ref: '#/components/schemas/AccessPolicy' type: object description: Input representation of access policy. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/AccessPolicy' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/accessrules: delete: deprecated: false description: '**Delete all access rules. Use filtering to specify which access rules will be deleted. _Check the response section for applicable examples (if any)._**' operationId: deleteMultipleAccessRule parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: true schema: type: boolean - description: 'For bulk delete needs the filter="ids:" and with bulk=true flag, Value is of format (including quotes): "ids:id1,id2,...".
ids is a comma-separated list of rule IDs to be deleted.
Supported filter criteria are "name","timeRange","action","sourceNetworks","destinationNetworks","sourcePorts","destinationPorts","sourceZones","destinationZones","applications","sourceDynamicObjects","destinationDynamicObjects","vlanTags","comments","users","urls","intrusionPolicy","sourceSecurityGroupTags","fts".' in: query name: filter required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessRule' type: object description: The input representation of access rule model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID ( Test DELETE of Access rule )' : value: action: ALLOW applications: applications: - id: '1553' name: 1&1 Internet type: Application destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true id: accessRuleUUID ipsPolicy: id: IntrusionPolicyUUID name: Connectivity Over Security type: IntrusionPolicy links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID logBegin: false logEnd: false logFiles: false metadata: readOnly: reason: SYSTEM state: true name: Rule2 originalSourceNetworks: {} sendEventsToFMC: false sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID name: vlan_tag_1 type: VlanTag schema: $ref: '#/components/schemas/AccessRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the list of all access rules associated with the specified policy ID.**' operationId: getAllAccessRule parameters: - description: For GetAll Filter criteria can be specified using the format "name:filterName;timeRange:true;action:filterAction;sourceNetworks:filterValue1,filterValue2....".
Supported filter criteria are "name","timeRange","action","sourceNetworks","originalClientIP","destinationNetworks","sourcePorts","destinationPorts","sourceZones","destinationZones","applications","sourceDynamicObjects","destinationDynamicObjects","vlanTags","comments","users","urls","intrusionPolicy","sourceSecurityGroupTags","fts". in: query name: filter required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules ( Success: Test GET ALL success )' : value: items: - id: accessRuleUUID1 links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID1 name: Rule1 type: AccessRule - id: accessRuleUUID2 links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID2 name: Rule2 type: AccessRule links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?offset=0&limit=1 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?expanded=true ( Success: Test GET ALL success with expanded=true )' : value: items: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationNetworks: {} destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject enabled: true id: accessRuleUUID2 links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID2 logBegin: false logEnd: false logFiles: false metadata: readOnly: reason: SYSTEM state: true name: Rule1 originalSourceNetworks: {} sendEventsToFMC: false sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourceNetworks: {} sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject type: AccessRule variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID name: vlan_tag_1 type: VlanTag - action: ALLOW applications: applications: - id: applictaionUUID name: 1&1 Internet type: Application destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZone name: Internal type: SecurityZone enabled: true id: accessRuleUUID1 ipsPolicy: id: IntrusionPolicyUUID name: Connectivity Over Security type: IntrusionPolicy links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID1 logBegin: false logEnd: false logFiles: false metadata: readOnly: reason: SYSTEM state: true name: Rule2 originalSourceNetworks: {} sendEventsToFMC: false sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZone name: External type: SecurityZone type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID name: vlan_tag_1 type: VlanTag links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/AccessRuleListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create access rules. _Check the response section for applicable examples (if any)._**' operationId: createMultipleAccessRule parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: false schema: type: boolean - description: Specifies that the rules will be inserted after the specified rule index. If no section or category is specified, the rules will be added to the section or category after the insertion point. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply. in: query name: insertAfter required: false schema: type: number - description: Specifies that the rules will be inserted before the specified rule index. If no section or category is specified, the rules will be added to the section or category before the insertion point. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply. in: query name: insertBefore required: false schema: type: number - description: Specifies the section into which the rules will be added. If this parameter is not used the section will be the default section. Only mandatory and default are allowed values. If a section is specified, a category cannot be specified. in: query name: section required: false schema: type: string - description: Specifies the category into which the rules will be added. If a category is specified it must exist or the request will fail. If a section is specified, a category cannot be specified. in: query name: category required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules ( Test POST of Access rule )' : value: action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?bulk=true ( POST Bulk insert of Access rules )' : value: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?bulk=true&section={mandatory | default} ( POST Bulk insert of Access rules into mandatory or default section )' : value: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?bulk=true&section={mandatory | default}&insertAfter=RuleIndex ( POST Bulk insert of Access rule into section after an index )' : value: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag ? 'Example 5 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?bulk=true&section={mandatory | default}&insertBefore=RuleIndex ( POST Bulk insert of Access rule into section before an index )' : value: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag ? 'Example 6 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?bulk=true&category=NameOfCategory ( POST Bulk insert of Access rule into a category )' : value: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag ? 'Example 7 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?bulk=true&category=NameOfCategory&insertAfter=RuleIndex ( POST Bulk insert of Access rule into category after an index )' : value: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert timeRangeObjects: - id: TimeRangeUUID name: TestTimeRange type: TimeRange type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag ? 'Example 8 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?bulk=true&category=NameOfCategory&insertBefore=RuleIndex ( POST Bulk insert of Access rule into category before an index )' : value: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert timeRangeObjects: - id: TimeRangeUUID name: TestTimeRange type: TimeRange type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag ? 'Example 9 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?bulk=true ( POST Bulk insert of Access rules )' : value: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert timeRangeObjects: - id: TimeRangeUUID name: TestTimeRange type: TimeRange type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag schema: $ref: '#/components/schemas/AccessRule' type: object description: The input representation of access rule model. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/AccessRule' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify all access rules. _Check the response section for applicable examples (if any)._**' operationId: updateMultipleAccessRule parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: true schema: type: boolean - description: Boolean indicating whether to change the entire object or only certain attributes of it. The default value is FALSE. in: query name: partialUpdate required: false schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID1 ( Test PUT of access rule )' : value: action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: false filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy id: accessRuleUUID1 ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag ? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?bulk=true ( PUT Bulk update of Access rules )' : value: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag schema: $ref: '#/components/schemas/AccessRule' type: object description: The input representation of access rule model to be updated. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/accessrules/{objectId}: delete: deprecated: false description: '**Delete the access rule associated with the specified policy ID and rule ID. _Check the response section for applicable examples (if any)._**' operationId: deleteAccessRule parameters: - description: Unique identifier of the access rule. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID ( Test DELETE of Access rule )' : value: action: ALLOW applications: applications: - id: '1553' name: 1&1 Internet type: Application destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true id: accessRuleUUID ipsPolicy: id: IntrusionPolicyUUID name: Connectivity Over Security type: IntrusionPolicy links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID logBegin: false logEnd: false logFiles: false metadata: readOnly: reason: SYSTEM state: true name: Rule2 originalSourceNetworks: {} sendEventsToFMC: false sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID name: vlan_tag_1 type: VlanTag schema: $ref: '#/components/schemas/AccessRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the access rule associated with the specified policy ID and rule ID.**' operationId: getAccessRule parameters: - description: Unique identifier of the access rule. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessruleUUID ( Success: Test GET method for Access rule )' : value: action: ALLOW applications: applications: - id: '1553' name: 1&1 Internet type: Application destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: destinationZonesUUID name: Internal type: SecurityZone enabled: true id: accessruleUUID ipsPolicy: id: ipsPolicyUUID name: Connectivity Over Security type: IntrusionPolicy links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessruleUUID logBegin: false logEnd: false logFiles: false metadata: readOnly: reason: SYSTEM state: true name: Rule2 originalSourceNetworks: {} sendEventsToFMC: false sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: sourceZoneObjectUUID name: External type: SecurityZone timeRangeObjects: - id: TimeRangeUUID name: TestTimeRange type: TimeRange type: AccessRule urls: urlCategoriesWithReputation: - category: id: categoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: variableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: vlanTagUUID name: vlan_tag_1 type: VlanTag schema: $ref: '#/components/schemas/AccessRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the access rule associated with the specified policy ID and rule ID. _Check the response section for applicable examples (if any)._**' operationId: updateAccessRule parameters: - description: Unique identifier of the access rule. in: path name: objectId required: true schema: type: string - description: Boolean indicating whether to change the entire object or only certain attributes of it. The default value is FALSE. in: query name: partialUpdate required: false schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules/accessRuleUUID1 ( Test PUT of access rule )' : value: action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: false filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy id: accessRuleUUID1 ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag ? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/accessrules?bulk=true ( PUT Bulk update of Access rules )' : value: - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule1 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag - action: ALLOW destinationDynamicObjects: objects: - id: dynamicObjectUUID name: destinationDynamicObject type: DynamicObject destinationPorts: objects: - id: ProtocolPortObjectUUID name: Bittorrent type: ProtocolPortObject destinationZones: objects: - id: SecurityZoneUUID name: Internal type: SecurityZone enabled: true filePolicy: id: filePolicyUuid name: filePolicyName type: FilePolicy ipsPolicy: id: ipsPolicyUuid name: ipsPlicyName type: IntrusionPolicy logBegin: false logEnd: false logFiles: false name: Rule2 newComments: - comment1 - comment2 sendEventsToFMC: false snmpConfig: id: snmpConfigUuid name: snmp_alert1 type: SNMPAlert sourceDynamicObjects: objects: - id: dynamicObjectUUID name: SourceDynamicObject type: DynamicObject sourcePorts: objects: - id: ProtocolPortObjectUUID name: AOL type: ProtocolPortObject sourceZones: objects: - id: SecurityZoneUUID name: External type: SecurityZone syslogConfig: id: syslogConfigUuid name: syslog_alert1 type: SyslogAlert type: AccessRule urls: urlCategoriesWithReputation: - category: id: URLCategoryUUID name: Weapons type: URLCategory reputation: BENIGN_SITES_WITH_SECURITY_RISKS type: UrlCategoryAndReputation variableSet: id: VariableSetUUID name: Default Set type: VariableSet vlanTags: objects: - id: VlanTagUUID1 name: vlan_tag_1 type: VlanTag - id: VlanTagUUID2 name: vlan_tag_2 type: VlanTag schema: $ref: '#/components/schemas/AccessRule' type: object description: The input representation of access rule model to be updated. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/categories: get: deprecated: false description: '**Get the list of all categories associated with the specified policy ID.**' operationId: getAllAccessPolicyCategory parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/categories?expanded=true ( Test GET ALL Success of AccessPolicyCategory )' : value: items: - id: id_of_category links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/categories/categoryUUID metadata: accessPolicy: id: id_of_access_policy name: access_policy_name type: AccessPolicy endIndex: index of the last Access Rule inside the category section: Section Name startIndex: index of the first Access Rule inside the category name: Category0001 type: Category links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/categories?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/AccessPolicyCategoryListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create a list of all categories associated with the specified policy ID. _Check the response section for applicable examples (if any)._**' operationId: createAccessPolicyCategory parameters: - description: Get, create or modify category in given section. Allowed values are mandatory or default. in: query name: section required: false schema: type: string - description: Create the category above the specified category. in: query name: aboveCategory required: false schema: type: string - description: Create the category above the given rule index. in: query name: insertBefore required: false schema: type: string - description: Create the category given the given rule index. in: query name: insertAfter required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/categories ( Test POST of AccessPolicyCategory to create new record )' : value: name: Category0001 type: Category schema: $ref: '#/components/schemas/AccessPolicyCategory' type: object description: The input category model. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/AccessPolicyCategory' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/categories/{objectId}: delete: deprecated: false description: '**Delete the category associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteAccessPolicyCategory parameters: - description: Unique identifier of the category. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/categories/categoryUUID ( Test DELETE of AccessPolicyCategory to delete a record )' : value: id: id_of_category links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/categories/categoryUUID metadata: accessPolicy: id: id_of_access_policy name: access_policy_name type: AccessPolicy endIndex: index of the last Access Rule inside the category section: Section Name startIndex: index of the first Access Rule inside the category name: Category0001 type: Category schema: $ref: '#/components/schemas/AccessPolicyCategory' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the category associated with the specified ID.**' operationId: getAccessPolicyCategory parameters: - description: Unique identifier of the category. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/categories/categoryUUID ( Test GET of AccessPolicyCategory to get a record )' : value: id: id_of_category links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/categories/categoryUUID metadata: accessPolicy: id: id_of_access_policy name: access_policy_name type: AccessPolicy endIndex: index of the last Access Rule inside the category section: Section Name startIndex: index of the first Access Rule inside the category name: Category0001 type: Category schema: $ref: '#/components/schemas/AccessPolicyCategory' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the category associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateAccessPolicyCategory parameters: - description: Unique identifier of the category. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/categories/categoryUUID ( Test PUT of AccessPolicyInheritanceSetting to update the record )' : value: id: id_of_category name: Category0001 type: Category schema: $ref: '#/components/schemas/AccessPolicyCategory' type: object description: The input representation of Category for specific Access Control policy to be updated. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessPolicyCategory' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/defaultactions: get: deprecated: false description: '**Get the list of all default actions associated with the specified access control policy ID.**' operationId: getAllDefaultAction parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefaultActionListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/defaultactions/{objectId}: get: deprecated: false description: '**Get the default action associated with the specified access control policy ID and default action ID.**' operationId: getDefaultAction parameters: - description: Unique identifier of the default action. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/ac_pol_uuid/defaultactions?expanded=true ( Test GET Success of AccessPolicy default action )' : value: items: - action: PERMIT id: defaultActionUUID intrusionPolicy: id: instrusionPolicyUUID name: Balanced Security and Connectivity type: IntrusionPolicy logBegin: true logEnd: true sendEventsToFMC: true snmpConfig: id: snmpConfigUUID name: snmp_alert1 type: SNMPAlert type: AccessPolicyDefaultAction variableSet: id: variableSetUUID name: Default Set type: VariableSet links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/defaultactions?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/DefaultAction' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the default action associated with the specified access control policy ID and default action ID. _Check the response section for applicable examples (if any)._**' operationId: updateDefaultAction parameters: - description: Unique identifier of the default action. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/DefaultAction' type: object description: The input representation of Default Action for specific Access Control policy to be updated. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefaultAction' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/inheritancesettings: get: deprecated: false description: '**Get all inheritance settings associated with specified access policy.**' operationId: getAllAccessPolicyInheritanceSetting parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/ac_pol_uuid/inheritancesettings?expanded=true ( Test GET ALL Success of AccessPolicy inheritance setting )' : value: items: - basePolicy: id: id_of_base_policy links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/basePolicyUUID/ name: Base Policy Name type: AccessPolicy id: inheritanceSettingUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/inheritancesettings/inheritanceSettingUUID metadata: timestamp: 12345678.0 type: AccessPolicyInheritanceSetting links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/inheritancesettings?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/AccessPolicyInheritanceSettingListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/inheritancesettings/{objectId}: get: deprecated: false description: '**Get the specified inheritance setting associated with the specified access policy.**' operationId: getAccessPolicyInheritanceSetting parameters: - description: Unique identifier of the access policy inheritance setting. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/inheritancesettings/inheritanceSettingUUID ( Test GET of AccessPolicyInheritanceSetting to get a record )' : value: basePolicy: id: id_of_base_policy links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/basePolicyUUID/ name: Base Policy Name type: AccessPolicy id: inheritanceSettingUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/inheritancesettings/inheritanceSettingUUID metadata: timestamp: 12345678.0 type: AccessPolicyInheritanceSetting schema: $ref: '#/components/schemas/AccessPolicyInheritanceSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the specified inheritance setting associated with the specified access policy. _Check the response section for applicable examples (if any)._**' operationId: updateAccessPolicyInheritanceSetting parameters: - description: Unique identifier of the access policy inheritance setting. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/inheritancesettings/inheritanceSettingUUID ( Test PUT of AccessPolicyInheritanceSetting to update the record )' : value: basePolicy: id: id_of_base_policy type: AccessPolicy id: id_of_inheritance_settings type: AccessPolicyInheritanceSetting schema: $ref: '#/components/schemas/AccessPolicyInheritanceSetting' type: object description: The input representation of Inheritance Setting for specific Access Control policy to be updated. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessPolicyInheritanceSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/loggingsettings: get: deprecated: false description: '**Get list of all logging settings associated with the specified access control policy ID.**' operationId: getAllAccessPolicyLoggingSettingModel parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessPolicyLoggingSettingModelListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/loggingsettings/{objectId}: get: deprecated: false description: '**Get the logging setting associated with the specified access control policy ID and logging setting ID.**' operationId: getAccessPolicyLoggingSettingModel parameters: - description: Unique identifier of the logging setting. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/ac_pol_uuid/loggingsettings?expanded=true ( Test GET Success of AccessPolicy logging settings )' : value: items: - enableFileAndMalwareSyslog: true fileAndMalwareSyslogConfig: id: 3f7ce75e-fd1b-11e8-8a68-ca0898f23acf name: test type: SyslogAlert fileAndMalwareSyslogSeverity: ALERT id: 005056A9-9F80-0ed3-0000-030064771231 metadata: timestamp: 0 severityForPlatformSettingSyslogConfig: CRIT syslogConfig: id: 8014f0d4-6a33-11e8-8755-90aed85e80f0 name: test type: SyslogAlert syslogConfigFromPlatformSetting: true type: LoggingSetting links: self: /api/fmc_config/v1/domain/domainUuid/policy/accesspolicies/ac_policy_id/loggingsettings?offset=0&limit=1&expanded=true paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/AccessPolicyLoggingSettingModel' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the logging setting associated with the specified access control policy ID and logging setting ID. _Check the response section for applicable examples (if any)._**' operationId: updateAccessPolicyLoggingSettingModel parameters: - description: Unique identifier of the logging setting. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessPolicyLoggingSettingModel' type: object description: The input representation of Logging Setting for specific Access Control policy to be updated. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessPolicyLoggingSettingModel' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/operational/hitcounts: delete: deprecated: false description: '**Clear the hit count values. _Check the response section for applicable examples (if any)._**' operationId: deleteHitCount parameters: - description: 'Value is of format (including quotes):

"deviceId:{uuid};ids:{uuid1,uuid2,..};fetchZeroHitCount:{true|false};name:{rule
          or policy name};lastHit:{number of days as per unit};lastHitUnit:{DAYS|WEEKS|MONTHS|YEARS}"

"deviceId:{uuid};ids:{uuid1,uuid2,..};fetchZeroHitCount:{true|false};name:{rule
          or policy name};lastHit:{number of days as per unit};lastHitUnit:{DAYS|WEEKS|MONTHS|YEARS}"

"deviceId:{uuid};ids:{uuid1,uuid2,..};fetchZeroHitCount:{true|false};name:{rule
          or policy name};lastHit:{number of days as per unit};lastHitUnit:{DAYS|WEEKS|MONTHS|YEARS}"

deviceId is UUID of device and is a mandatory field.
ids returns hitcounts of access rules if set to list of rule UUIDs. If this key is not used, all access rules will be returned.
fetchZeroHitCount returns only access rules whose hit count is zero if true.
name returns only access rule name or policy name matchesname.
lastHit returns only access rules hit in last specified number of days as per lastHitUnit unit.
lastHitUnit unit of number of last hit days - DAYS, WEEKS, MONTHS or YEARS.

(Note that fetchZeroHitCount,name,lastHit,lastHitUnit filters are applicable only in GET operation and if ids filter is not used)' in: query name: filter required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/operational/hitcounts?filter="{filterString}";expanded=true ( Test PUT (Refresh) of HitCount )' : value: link: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/operational/hitcounts?filter="deviceId:{deviceId}"&expanded=true metadata: task: id: task_id links: self: link_to_task_status type: TaskStatus type: HitCount schema: $ref: '#/components/schemas/HitCount' type: object description: OK '202': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/operational/hitcounts?filter="{filterString}";expanded=true ( Test PUT (Refresh) of HitCount )' : value: link: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/containerUUID/operational/hitcounts?filter="deviceId:{deviceId}"&expanded=true metadata: task: id: task_id links: self: link_to_task_status type: TaskStatus type: HitCount schema: $ref: '#/components/schemas/HitCount' type: object description: Accepted default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/securityintelligencepolicies: get: deprecated: false description: '**Get all security intelligence policies associated with the specified access policy.**' operationId: getAllAccessPolicySecurityIntelligencePolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/securityintelligencepolicies?expanded=true ( Test GET ALL Success of AccessPolicy security intelligence policy )' : value: items: - dnsPolicy: blocklistLogging: enableLogging: false id: DNSPolicyUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/DNSPolicyUUID name: name of the DNS policy sendLogsToEventViewer: true sendLogsToSyslogServer: true type: DNSPolicy id: securityIntelligencePolicyUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/securityintelligencepolicies/securityintelligencepolicyUUID metadata: timestamp: 1601475473350.0 networks: allowlist: - network: id: SINetworkListUUID links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworklists/SINetworkListUUID name: SINetworkList type: SINetworkList blocklist: - network: id: NetworkUUID links: self: /fmc_config/v1/domain/DomainUUID/object/networks/NetworkUUID name: Network type: Network blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true type: SecurityIntelligencePolicy urls: allowlist: - sourceZone: id: SecurityZoneUUID links: self: /fmc_config/v1/domain/DomainUUID/object/securityzones/SecurityZoneUUID name: SecurityZone type: SecurityZone url: id: SIURLListObjectUUID links: self: /fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListObjectUUID name: SIURLListObject type: SIURLList blocklist: - sourceZone: id: SecurityZoneUUID links: self: /fmc_config/v1/domain/DomainUUID/object/securityzones/SecurityZoneUUID name: SecurityZone type: SecurityZone url: id: SIURLFeedUUID links: self: /fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedUUID name: SIURLFeed type: SIURLFeed blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/securityintelligencepolicies?offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/AccessPolicySecurityIntelligencePolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{containerUUID}/securityintelligencepolicies/{objectId} : get: deprecated: false description: '**Get the security intelligence policy associated with the specified access policy.**' operationId: getAccessPolicySecurityIntelligencePolicy parameters: - description: Unique identifier of the security intelligence policy associated with an access policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/securityintelligencepolicies/securityintelligencepolicyUUID ( Test GET of AccessPolicySecurityIntelligencePolicies to get a record )' : value: dnsPolicy: blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true id: DNSPolicyUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/DNSPolicyUUID name: name of the DNS policy type: DNSPolicy id: securityIntelligencePolicyUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/securityintelligencepolicies/securityintelligencepolicyUUID metadata: timestamp: 1601475473350.0 networks: allowlist: - network: id: SINetworkListUUID links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworklists/SINetworkListUUID name: SINetworkList type: SINetworkList blocklist: - network: id: NetworkUUID links: self: /fmc_config/v1/domain/DomainUUID/object/networks/NetworkUUID name: Network type: Network blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true type: SecurityIntelligencePolicy urls: allowlist: - sourceZone: id: SecurityZoneUUID links: self: /fmc_config/v1/domain/DomainUUID/object/securityzones/SecurityZoneUUID name: SecurityZone type: SecurityZone url: id: SIURLListObjectUUID links: self: /fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListObjectUUID name: SIURLListObject type: SIURLList blocklist: - sourceZone: id: SecurityZoneUUID links: self: /fmc_config/v1/domain/DomainUUID/object/securityzones/SecurityZoneUUID name: SecurityZone type: SecurityZone url: id: SIURLFeedUUID links: self: /fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedUUID name: SIURLFeed type: SIURLFeed blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true schema: $ref: '#/components/schemas/AccessPolicySecurityIntelligencePolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Update the Security Intelligence policy associated with the specified access control policy. _Check the response section for applicable examples (if any)._**' operationId: updateAccessPolicySecurityIntelligencePolicy parameters: - description: Unique identifier of the Security Intelligence policy associated with an access control policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/securityintelligencepolicies/securityintelligencepolicyUUID ( Test PUT of AccessPolicySecurityIntelligencePolicies to get a record )' : value: dnsPolicy: blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true id: DNSPolicyUUID name: name of the DNS policy type: DNSPolicy id: securityIntelligencePolicyUUID networks: allowlist: - network: id: SINetworkListUUID name: SINetworkList type: SINetworkList blocklist: - network: id: NetworkUUID name: Network type: Network blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true type: SecurityIntelligencePolicy urls: allowlist: - sourceZone: id: SecurityZoneUUID name: SecurityZone type: SecurityZone url: id: SIURLListObjectUUID name: SIURLListObject type: SIURLList blocklist: - sourceZone: id: SecurityZoneUUID name: SecurityZone type: SecurityZone url: id: SIURLFeedUUID name: SIURLFeed type: SIURLFeed blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true schema: $ref: '#/components/schemas/AccessPolicySecurityIntelligencePolicy' type: object description: The input representation of the Security Intelligence policy for the specific access control policy to be updated. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/securityintelligencepolicies/securityintelligencepolicyUUID ( Test PUT of AccessPolicySecurityIntelligencePolicies to get a record )' : value: dnsPolicy: blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true id: DNSPolicyUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/DNSPolicyUUID name: name of the DNS policy type: DNSPolicy id: securityIntelligencePolicyUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyUUID/securityintelligencepolicies/securityintelligencepolicyUUID metadata: timestamp: 1601475473350.0 networks: allowlist: - network: id: SINetworkListUUID links: self: /fmc_config/v1/domain/DomainUUID/object/sinetworklists/SINetworkListUUID name: SINetworkList type: SINetworkList blocklist: - network: id: NetworkUUID links: self: /fmc_config/v1/domain/DomainUUID/object/networks/NetworkUUID name: Network type: Network blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true type: SecurityIntelligencePolicy urls: allowlist: - sourceZone: id: SecurityZoneUUID links: self: /fmc_config/v1/domain/DomainUUID/object/securityzones/SecurityZoneUUID name: SecurityZone type: SecurityZone url: id: SIURLListObjectUUID links: self: /fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListObjectUUID name: SIURLListObject type: SIURLList blocklist: - sourceZone: id: SecurityZoneUUID links: self: /fmc_config/v1/domain/DomainUUID/object/securityzones/SecurityZoneUUID name: SecurityZone type: SecurityZone url: id: SIURLFeedUUID links: self: /fmc_config/v1/domain/DomainUUID/object/siurlfeeds/SIURLFeedUUID name: SIURLFeed type: SIURLFeed blocklistLogging: enableLogging: false sendLogsToEventViewer: true sendLogsToSyslogServer: true schema: $ref: '#/components/schemas/AccessPolicySecurityIntelligencePolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies/{objectId}: delete: deprecated: false description: '**Delete the access control policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteAccessPolicy parameters: - description: Unique identifier of the access control policy. in: path name: objectId required: true schema: type: string - description: Shows any warnings when deleting an access policy, if set to false. If not specified, value is set to true and warnings are ignored. Allowed values are true and false. in: query name: ignoreWarning required: false schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/policy/accesspolicies ( Test DELETE success of AccessPolicy policy )': value: defaultAction: id: id_of_default_action type: AccessPolicyDefaultAction description: policy to test FMC implementation name: AccessPolicy1_updated type: AccessPolicy schema: $ref: '#/components/schemas/AccessPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the access control policy associated with the specified ID.**' operationId: getAccessPolicy parameters: - description: Unique identifier of the access control policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/accesspolicies/accesspolicyuuid ( Test GET Success of AccessPolicy policy )' : value: defaultAction: id: id_of_default_action type: AccessPolicyDefaultAction description: policy to test FMC implementation name: AccessPolicy1_updated type: AccessPolicy schema: $ref: '#/components/schemas/AccessPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the access control policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateAccessPolicy parameters: - description: Unique identifier of the access control policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessPolicy' type: object description: Input representation of access control policy to be updated. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies: get: deprecated: false description: '**Get the chassis platform settings policies.**' operationId: getAllChassisPlatformSettingsPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies ( Example payloads for GET listing on chassis platform settings policy. )' : value: items: - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid1 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid1 name: chassis platform settings policy1 type: ChassisPlatformSettingsPolicy - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid2 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid2 name: chassis platform settings policy2 type: ChassisPlatformSettingsPolicy links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GETALL /api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies?expanded=true ( Example payload for GET on chassis platform settings policy with expanded=true )' : value: items: - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid1 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid1 name: chassis platform settings policy1 type: ChassisPlatformSettingsPolicy - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid2 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid2 name: chassis platform settings policy2 type: ChassisPlatformSettingsPolicy links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies?offset=0&limit=2&expanded=true paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 3 : GETALL /api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies ( Example payloads for GET listing on chassis platform settings policy. )' : value: items: - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid1 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid1 name: chassis platform settings policy1 type: ChassisPlatformSettingsPolicy - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid2 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid2 name: chassis platform settings policy2 type: ChassisPlatformSettingsPolicy links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 4 : GETALL /api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies?expanded=true ( Example payload for GET on chassis platform settings policy with expanded=true )' : value: items: - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid1 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid1 name: chassis platform settings policy1 type: ChassisPlatformSettingsPolicy - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid2 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid2 name: chassis platform settings policy2 type: ChassisPlatformSettingsPolicy links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies?offset=0&limit=2&expanded=true paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisPlatformSettingsPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create chassis platform settings policies. _Check the response section for applicable examples (if any)._**' operationId: createChassisPlatformSettingsPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies ( Example payloads for POST on chassis platform settings policy )' : value: description: Chassis Platform Settings Policy for testing rest API name: chassisPlatformSettingsPolicy1 type: ChassisPlatformSettingsPolicy schema: $ref: '#/components/schemas/ChassisPlatformSettingsPolicy' type: object description: The input chassis platform settings policy required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies ( Example payloads for POST on chassis platform settings policy )' : value: description: Chassis Platform Settings Policy for testing rest API id: Uuid1 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/Uuid1 name: chassisPlatformSettingsPolicy1 type: ChassisPlatformSettingsPolicy schema: $ref: '#/components/schemas/ChassisPlatformSettingsPolicy' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/accesslistsettings: get: deprecated: false description: '**Get access list policy settings for the specified chassis platform settings policy from the management center.**' operationId: getAllChassisAccessListSetting parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/accesslistsettings ( Example payload for GET on ChassisAccessListSetting Policy )' : value: items: - id: AccessListSettingUUID name: AccessList sshAccessList: literals: - type: Host value: 1.1.1.3 - type: Network value: 2.2.2.2/24 objects: - id: 00000000-0000-0ed3-0000-012884902136 name: network_obj_1 type: Network - id: 00000000-0000-0ed3-0000-012884907383 name: network_grp_1 type: NetworkGroup type: AccessListSetting links: self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/chassisplatformsettingspolicies/0050568A-CCB0-0ed3-0000-193273528368/accesslistsettings?offset=0&limit=25 ? 'Example 2 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/accesslistsettings ( Example payload for GET on ChassisAccessListSetting Policy )' : value: items: - id: AccessListSettingUUID name: AccessList sshAccessList: literals: - type: Host value: 1.1.1.3 - type: Network value: 2.2.2.2/24 objects: - id: 00000000-0000-0ed3-0000-012884902136 name: network_obj_1 type: Network - id: 00000000-0000-0ed3-0000-012884907383 name: network_grp_1 type: NetworkGroup type: AccessListSetting links: self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/chassisplatformsettingspolicies/0050568A-CCB0-0ed3-0000-193273528368/accesslistsettings?offset=0&limit=25 schema: $ref: '#/components/schemas/ChassisAccessListSettingListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/accesslistsettings/{objectId} : get: deprecated: false description: '**Get the access list policy setting associated with the specified ID for the specified chassis platform settings policy from the management center.**' operationId: getChassisAccessListSetting parameters: - description: Unique identifier of the access list policy setting. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/accesslistsettings ( Example payload for GET on ChassisAccessListSetting Policy )' : value: items: - id: AccessListSettingUUID name: AccessList sshAccessList: literals: - type: Host value: 1.1.1.3 - type: Network value: 2.2.2.2/24 objects: - id: 00000000-0000-0ed3-0000-012884902136 name: network_obj_1 type: Network - id: 00000000-0000-0ed3-0000-012884907383 name: network_grp_1 type: NetworkGroup type: AccessListSetting links: self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/chassisplatformsettingspolicies/0050568A-CCB0-0ed3-0000-193273528368/accesslistsettings?offset=0&limit=25 ? 'Example 2 : GET /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/accesslistsettings/accesslistsettingUUID ( Example payload for GET on ChassisAccessListSetting policy )' : value: id: AccessListSettingUUID name: AccessList sshAccessList: literals: - type: Host value: 1.1.1.3 - type: Network value: 2.2.2.2/24 objects: - id: 00000000-0000-0ed3-0000-012884902136 name: network_obj_1 type: Network - id: 00000000-0000-0ed3-0000-012884907383 name: network_grp_1 type: NetworkGroup type: AccessListSetting schema: $ref: '#/components/schemas/ChassisAccessListSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the access list policy setting associated with the specified ID for the specified chassis platform settings policy from the management center. _Check the response section for applicable examples (if any)._**' operationId: updateChassisAccessListSetting parameters: - description: Unique identifier of the access list policy setting. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/accesslistsettings/accesslistsettingUUID2 ( Example payload for PUT on ChassisAccessListSetting Policy. )' : value: id: AccessListSettingUUID name: AccessList sshAccessList: literals: - type: Host value: 1.1.1.3 - type: Network value: 2.2.2.2/24 objects: - id: 00000000-0000-0ed3-0000-012884902136 name: network_obj_1 type: Network - id: 00000000-0000-0ed3-0000-012884907383 name: network_grp_1 type: NetworkGroup type: AccessListSetting schema: $ref: '#/components/schemas/ChassisAccessListSetting' type: object description: Input representation of access list policy setting. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/accesslistsettings/accesslistsettingUUID2 ( Example payload for PUT on ChassisAccessListSetting Policy. )' : value: id: AccessListSettingUUID name: AccessList sshAccessList: literals: - type: Host value: 1.1.1.3 - type: Network value: 2.2.2.2/24 objects: - id: 00000000-0000-0ed3-0000-012884902136 name: network_obj_1 type: Network - id: 00000000-0000-0ed3-0000-012884907383 name: network_grp_1 type: NetworkGroup type: AccessListSetting schema: $ref: '#/components/schemas/ChassisAccessListSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings: get: deprecated: false description: '**Get all DNS settings policies for a device.**' operationId: getAllDNSSettings parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings ( Example payload for GET on DNS Settings Policy )' : value: items: - dnsServerGroupList: - id: 0050568A-CCB0-0ed3-0000-064424509466 name: DNSServerGroupObjectName1 type: DNSServerGroupObject enableDNSNameResolution: true id: dnssettingsUUID links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/dnssettings/dnssettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 type: DNSSettings links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/dnssettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings ( Example payload for GET on DNS Settings Policy )' : value: items: - dnsServerGroupList: - id: 0050568A-CCB0-0ed3-0000-064424509466 name: DNSServerGroupObjectName1 type: DNSServerGroupObject enableDNSNameResolution: true id: dnssettingsUUID links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/dnssettings/dnssettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 type: DNSSettings links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/dnssettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/DNSSettingsListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings/{objectId} : get: deprecated: false description: '**Get the DNS settings platform settings policy associated with the specified ID.**' operationId: getDNSSettings parameters: - description: The identifier of the settings policy to which the DNS settings policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings ( Example payload for GET on DNS Settings Policy )' : value: items: - dnsServerGroupList: - id: 0050568A-CCB0-0ed3-0000-064424509466 name: DNSServerGroupObjectName1 type: DNSServerGroupObject enableDNSNameResolution: true id: dnssettingsUUID links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/dnssettings/dnssettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 type: DNSSettings links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/dnssettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/dnssettings/dnssettingsUUID ( Example payload for GET on DNSSettings policy )' : value: dnsServerGroupList: - id: 0050568A-CCB0-0ed3-0000-064424509466 name: DNSServerGroupObjectName1 type: DNSServerGroupObject enableDNSNameResolution: true id: dnssettingsUUID links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/dnssettings/dnssettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 type: DNSSettings schema: $ref: '#/components/schemas/DNSSettings' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the DNS settings platform settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateDNSSettings parameters: - description: The identifier of the settings policy to which the DNS settings policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/dnssettings/dnssettingsUUID2 ( Example payload for PUT on DNS Settings Policy. )' : value: dnsServerGroupList: - id: DNSServerGroupObjectUUID1 name: DNSServerGroupObjectName1 type: DNSServerGroupObject enableDNSNameResolution: true id: dnssettingsUUID2 type: DNSSettings schema: $ref: '#/components/schemas/DNSSettings' type: object description: Input representation of DNS settings policy. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/dnssettings/dnssettingsUUID2 ( Example payload for PUT on DNS Settings Policy. )' : value: dnsServerGroupList: - id: DNSServerGroupObjectUUID1 name: DNSServerGroupObjectName1 type: DNSServerGroupObject enableDNSNameResolution: true id: dnssettingsUUID2 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/dnssettings/dnssettingsUUID2 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain timestamp: 1640170486880.0 type: DNSSettings schema: $ref: '#/components/schemas/DNSSettings' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings: get: deprecated: false description: '**Get all SSH client settings for a particular chassis platform settings policy.**' operationId: getAllSshClientSetting parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings ( Example payload for GET on SshClientSetting Policy )' : value: items: - encryptAlgo: - 3des-cbc - aes128-cbc - aes128-ctr id: sshclientsettingsUUID kexAlgo: - curve25519-sha256 - curve25519-sha256 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshclientsettings/sshclientsettingsUUID macAlgo: - hmac-sha-1 - hmac-sha2-256 metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 strictKeyCheckEncryption: disable timeRekeyLimit: 120 type: SshClientSetting volumeRekeyLimit: 3978 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshclientsettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings ( Example payload for GET on SshClientSetting Policy )' : value: items: - encryptAlgo: - 3des-cbc - aes128-cbc - aes128-ctr id: sshclientsettingsUUID kexAlgo: - curve25519-sha256 - curve25519-sha256 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshclientsettings/sshclientsettingsUUID macAlgo: - hmac-sha-1 - hmac-sha2-256 metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 strictKeyCheckEncryption: disable timeRekeyLimit: 120 type: SshClientSetting volumeRekeyLimit: 3978 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshclientsettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SshClientSettingListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings/{objectId} : get: deprecated: false description: '**Get the SSH client setting associated with the specified ID for a particular chassis platform settings policy.**' operationId: getSshClientSetting parameters: - description: Unique identifier of the SSH client setting. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings ( Example payload for GET on SshClientSetting Policy )' : value: items: - encryptAlgo: - 3des-cbc - aes128-cbc - aes128-ctr id: sshclientsettingsUUID kexAlgo: - curve25519-sha256 - curve25519-sha256 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshclientsettings/sshclientsettingsUUID macAlgo: - hmac-sha-1 - hmac-sha2-256 metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 strictKeyCheckEncryption: disable timeRekeyLimit: 120 type: SshClientSetting volumeRekeyLimit: 3978 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshclientsettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshclientsettings/sshclientsettingsUUID ( Example payload for GET on SshClientSetting policy )' : value: encryptAlgo: - 3des-cbc - aes128-cbc - aes128-ctr id: sshclientsettingsUUID kexAlgo: - curve25519-sha256 - curve25519-sha256 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshclientsettings/sshclientsettingsUUID macAlgo: - hmac-sha-1 - hmac-sha2-256 metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 strictKeyCheckEncryption: disable timeRekeyLimit: 120 type: SshClientSetting volumeRekeyLimit: 3978 schema: $ref: '#/components/schemas/SshClientSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the SSH client setting associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._**' operationId: updateSshClientSetting parameters: - description: Unique identifier of the SSH client setting. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshclientsettings/sshclientsettingsUUID2 ( Example payload for PUT on SshClientSetting Policy. )' : value: encryptAlgo: - aes128-cbc - aes128-ctr id: sshclientsettingsUUID2 kexAlgo: - curve25519-sha256 - curve25519-sha256 macAlgo: - hmac-sha-1 - hmac-sha2-256 strictKeyCheckEncryption: enable timeRekeyLimit: 240 type: SshClientSetting volumeRekeyLimit: 10000 schema: $ref: '#/components/schemas/SshClientSetting' type: object description: Input representation of SSH client setting. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshclientsettings/sshclientsettingsUUID2 ( Example payload for PUT on SshClientSetting Policy. )' : value: encryptAlgo: - aes128-cbc - aes128-ctr id: sshclientsettingsUUID2 kexAlgo: - curve25519-sha256 - curve25519-sha256 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshclientsettings/sshclientsettingsUUID2 macAlgo: - hmac-sha-1 - hmac-sha2-256 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain timestamp: 1640170486880.0 strictKeyCheckEncryption: enable timeRekeyLimit: 240 type: SshClientSetting volumeRekeyLimit: 10000 schema: $ref: '#/components/schemas/SshClientSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings: get: deprecated: false description: '**Get all SSH server settings for a particular chassis platform settings policy.**' operationId: getAllSshServerSetting parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings ( Example payload for GET on SshServerSetting Policy )' : value: items: - enableSshServer: true encryptAlgo: - 3des-cbc - aes128-cbc - aes128-ctr hostKey: 1032 id: sshserversettingsUUID kexAlgo: - curve25519-sha256 - curve25519-sha256 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings/sshserversettingsUUID macAlgo: - hmac-sha-1 - hmac-sha2-256 metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 timeRekeyLimit: 120 type: SshServerSetting volumeRekeyLimit: 3978 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings ( Example payload for GET on SshServerSetting Policy )' : value: items: - enableSshServer: true encryptAlgo: - 3des-cbc - aes128-cbc - aes128-ctr hostKey: 1032 id: sshserversettingsUUID kexAlgo: - curve25519-sha256 - curve25519-sha256 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings/sshserversettingsUUID macAlgo: - hmac-sha-1 - hmac-sha2-256 metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 timeRekeyLimit: 120 type: SshServerSetting volumeRekeyLimit: 3978 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SshServerSettingListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings/{objectId} : get: deprecated: false description: '**Get the SSH server setting associated with the specified ID for a particular chassis platform settings policy.**' operationId: getSshServerSetting parameters: - description: Unique identifier of the SSH server setting. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings ( Example payload for GET on SshServerSetting Policy )' : value: items: - enableSshServer: true encryptAlgo: - 3des-cbc - aes128-cbc - aes128-ctr hostKey: 1032 id: sshserversettingsUUID kexAlgo: - curve25519-sha256 - curve25519-sha256 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings/sshserversettingsUUID macAlgo: - hmac-sha-1 - hmac-sha2-256 metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 timeRekeyLimit: 120 type: SshServerSetting volumeRekeyLimit: 3978 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/sshserversettings/sshserversettingsUUID ( Example payload for GET on SshServerSetting policy )' : value: enableSshServer: true encryptAlgo: - 3des-cbc - aes128-cbc - aes128-ctr hostKey: 1032 id: sshserversettingsUUID kexAlgo: - curve25519-sha256 - curve25519-sha256 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings/sshserversettingsUUID macAlgo: - hmac-sha-1 - hmac-sha2-256 metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 timeRekeyLimit: 120 type: SshServerSetting volumeRekeyLimit: 3978 schema: $ref: '#/components/schemas/SshServerSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the SSH server setting associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._**' operationId: updateSshServerSetting parameters: - description: Unique identifier of the SSH server setting. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings/sshserversettingsUUID2 ( Example payload for PUT on SshServerSetting Policy. )' : value: enableSshServer: true encryptAlgo: - aes128-cbc - aes128-ctr hostKey: 2000 id: sshserversettingsUUID2 kexAlgo: - curve25519-sha256 - curve25519-sha256 macAlgo: - hmac-sha-1 - hmac-sha2-256 timeRekeyLimit: 240 type: SshServerSetting volumeRekeyLimit: 10000 schema: $ref: '#/components/schemas/SshServerSetting' type: object description: Input representation of SSH server setting. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings/sshserversettingsUUID2 ( Example payload for PUT on SshServerSetting Policy. )' : value: enableSshServer: true encryptAlgo: - aes128-cbc - aes128-ctr hostKey: 2000 id: sshserversettingsUUID2 kexAlgo: - curve25519-sha256 - curve25519-sha256 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/sshserversettings/sshserversettingsUUID2 macAlgo: - hmac-sha-1 - hmac-sha2-256 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain timestamp: 1640170486880.0 timeRekeyLimit: 240 type: SshServerSetting volumeRekeyLimit: 10000 schema: $ref: '#/components/schemas/SshServerSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings: get: deprecated: false description: '**Get all syslog settings policies for a particular chassis platform settings policy.**' operationId: getAllChassisSyslogSetting parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsetting ( Example payload for GET on ChassisSyslogSetting Policy )' : value: items: - id: SyslogSettingUUID syslogConsole: isSyslogConsoleEnabled: 'true' severity: EMERGENCIES syslogFile: fileSizeLimit: '4194304' isSyslogFileEnabled: 'true' severity: CRITICAL syslogMonitor: isSyslogMonitorEnabled: 'true' severity: CRITICAL syslogRemoteClients: - forwardingFacility: LOCAL7 hostname: 192.168.123.42 isClientEnabled: 'true' severity: ERRORS - forwardingFacility: LOCAL7 hostname: 192.168.32.123 isClientEnabled: 'true' severity: WARNINGS - forwardingFacility: LOCAL7 hostname: 192.168.23.52 isClientEnabled: 'true' severity: CRITICAL syslogSource: isAuditsEnabled: 'true' isEventsEnabled: 'true' isFaultsEnabled: 'true' type: SyslogSetting links: self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/chassisplatformsettingspolicies/0050568A-CCB0-0ed3-0000-193273528368/syslogsettings?offset=0&limit=25 paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsetting ( Example payload for GET on ChassisSyslogSetting Policy )' : value: items: - id: SyslogSettingUUID syslogConsole: isSyslogConsoleEnabled: 'true' severity: EMERGENCIES syslogFile: fileSizeLimit: '4194304' isSyslogFileEnabled: 'true' severity: CRITICAL syslogMonitor: isSyslogMonitorEnabled: 'true' severity: CRITICAL syslogRemoteClients: - forwardingFacility: LOCAL7 hostname: 192.168.123.42 isClientEnabled: 'true' severity: ERRORS - forwardingFacility: LOCAL7 hostname: 192.168.32.123 isClientEnabled: 'true' severity: WARNINGS - forwardingFacility: LOCAL7 hostname: 192.168.23.52 isClientEnabled: 'true' severity: CRITICAL syslogSource: isAuditsEnabled: 'true' isEventsEnabled: 'true' isFaultsEnabled: 'true' type: SyslogSetting links: self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/chassisplatformsettingspolicies/0050568A-CCB0-0ed3-0000-193273528368/syslogsettings?offset=0&limit=25 paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisSyslogSettingListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings/{objectId} : get: deprecated: false description: '**Get the syslog settings policy associated with the specified ID for a particular chassis platform settings policy.**' operationId: getChassisSyslogSetting parameters: - description: Unique identifier of the syslog settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsetting ( Example payload for GET on ChassisSyslogSetting Policy )' : value: items: - id: SyslogSettingUUID syslogConsole: isSyslogConsoleEnabled: 'true' severity: EMERGENCIES syslogFile: fileSizeLimit: '4194304' isSyslogFileEnabled: 'true' severity: CRITICAL syslogMonitor: isSyslogMonitorEnabled: 'true' severity: CRITICAL syslogRemoteClients: - forwardingFacility: LOCAL7 hostname: 192.168.123.42 isClientEnabled: 'true' severity: ERRORS - forwardingFacility: LOCAL7 hostname: 192.168.32.123 isClientEnabled: 'true' severity: WARNINGS - forwardingFacility: LOCAL7 hostname: 192.168.23.52 isClientEnabled: 'true' severity: CRITICAL syslogSource: isAuditsEnabled: 'true' isEventsEnabled: 'true' isFaultsEnabled: 'true' type: SyslogSetting links: self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/chassisplatformsettingspolicies/0050568A-CCB0-0ed3-0000-193273528368/syslogsettings?offset=0&limit=25 paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsetting/syslogsettingUUID ( Example payload for GET on ChassisSyslogSetting policy )' : value: id: SyslogSettingUUID links: self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/chassisplatformsettingspolicies//syslogsettings/SyslogSettingUUID syslogConsole: isSyslogConsoleEnabled: 'true' severity: EMERGENCIES syslogFile: fileSizeLimit: '4194304' isSyslogFileEnabled: 'true' severity: CRITICAL syslogMonitor: isSyslogMonitorEnabled: 'true' severity: CRITICAL syslogRemoteClients: - forwardingFacility: LOCAL7 hostname: 192.168.123.42 isClientEnabled: 'true' severity: ERRORS - forwardingFacility: LOCAL7 hostname: 192.168.32.123 isClientEnabled: 'true' severity: WARNINGS - forwardingFacility: LOCAL7 hostname: 192.168.23.52 isClientEnabled: 'true' severity: CRITICAL syslogSource: isAuditsEnabled: 'true' isEventsEnabled: 'true' isFaultsEnabled: 'true' type: SyslogSetting schema: $ref: '#/components/schemas/ChassisSyslogSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the syslog settings policy associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._**' operationId: updateChassisSyslogSetting parameters: - description: Unique identifier of the syslog settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/syslogsetting/syslogsettingUUID2 ( Example payload for PUT on ChassisSyslogSetting Policy. )' : value: id: SyslogSettingUUID syslogConsole: isSyslogConsoleEnabled: 'true' severity: EMERGENCIES syslogFile: fileSizeLimit: '4194304' isSyslogFileEnabled: 'true' severity: CRITICAL syslogMonitor: isSyslogMonitorEnabled: 'true' severity: CRITICAL syslogRemoteClients: - forwardingFacility: LOCAL7 hostname: 192.168.123.42 isClientEnabled: 'true' severity: ERRORS - forwardingFacility: LOCAL7 hostname: 192.168.32.123 isClientEnabled: 'true' severity: WARNINGS - forwardingFacility: LOCAL7 hostname: 192.168.23.52 isClientEnabled: 'true' severity: CRITICAL syslogSource: isAuditsEnabled: 'true' isEventsEnabled: 'true' isFaultsEnabled: 'true' type: SyslogSetting schema: $ref: '#/components/schemas/ChassisSyslogSetting' type: object description: Input representation of chassis syslog settings policy. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/syslogsetting/syslogsettingUUID2 ( Example payload for PUT on ChassisSyslogSetting Policy. )' : value: id: SyslogSettingUUID links: self: /api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/chassisplatformsettingspolicies/0050568A-CCB0-0ed3-0000-193273528368/syslogsettings/SyslogSettingUUID syslogConsole: isSyslogConsoleEnabled: 'true' severity: EMERGENCIES syslogFile: fileSizeLimit: '4194304' isSyslogFileEnabled: 'true' severity: CRITICAL syslogMonitor: isSyslogMonitorEnabled: 'true' severity: CRITICAL syslogRemoteClients: - forwardingFacility: LOCAL7 hostname: 192.168.123.42 isClientEnabled: 'true' severity: ERRORS - forwardingFacility: LOCAL7 hostname: 192.168.32.123 isClientEnabled: 'true' severity: WARNINGS - forwardingFacility: LOCAL7 hostname: 192.168.23.52 isClientEnabled: 'true' severity: CRITICAL syslogSource: isAuditsEnabled: 'true' isEventsEnabled: 'true' isFaultsEnabled: 'true' type: SyslogSetting schema: $ref: '#/components/schemas/ChassisSyslogSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings : get: deprecated: false description: '**Get all time synchronization settings policies for a particular chassis platform settings policy.**' operationId: getAllChassisTimeSynchronizationSetting parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings ( Example payload for GET on ChassisTimeSynchronizationSetting Policy )' : value: items: - id: timesynchronizationsettingsUUID isNtpFromMgmtCentre: true links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timesynchronizationsettings/timesynchronizationsettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 ntpServers: - id: 0050568A-CCB0-0ed3-0000-064424509466 name: ntpServerObjectName1 type: ntpServerObject type: ChassisTimeSynchronizationSetting links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timesynchronizationsettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings ( Example payload for GET on ChassisTimeSynchronizationSetting Policy )' : value: items: - id: timesynchronizationsettingsUUID isNtpFromMgmtCentre: true links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timesynchronizationsettings/timesynchronizationsettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 ntpServers: - id: 0050568A-CCB0-0ed3-0000-064424509466 name: ntpServerObjectName1 type: ntpServerObject type: ChassisTimeSynchronizationSetting links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timesynchronizationsettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisTimeSynchronizationSettingListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings/{objectId} : get: deprecated: false description: '**Get the time synchronization settings policy associated with the specified ID for a particular chassis platform settings policy.**' operationId: getChassisTimeSynchronizationSetting parameters: - description: Unique identifier of the time synchronization settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings ( Example payload for GET on ChassisTimeSynchronizationSetting Policy )' : value: items: - id: timesynchronizationsettingsUUID isNtpFromMgmtCentre: true links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timesynchronizationsettings/timesynchronizationsettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 ntpServers: - id: 0050568A-CCB0-0ed3-0000-064424509466 name: ntpServerObjectName1 type: ntpServerObject type: ChassisTimeSynchronizationSetting links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timesynchronizationsettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timesynchronizationsettings/timesynchronizationsettingsUUID ( Example payload for GET on ChassisTimeSynchronizationSetting policy )' : value: id: timesynchronizationsettingsUUID isNtpFromMgmtCentre: true links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timesynchronizationsettings/timesynchronizationsettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 ntpServers: - id: 0050568A-CCB0-0ed3-0000-064424509466 name: ntpServerObjectName1 type: ntpServerObject type: ChassisTimeSynchronizationSetting schema: $ref: '#/components/schemas/ChassisTimeSynchronizationSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the time synchronization settings policy associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._**' operationId: updateChassisTimeSynchronizationSetting parameters: - description: Unique identifier of the time synchronization settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timesynchronizationsettings/timesynchronizationsettingsUUID2 ( Example payload for PUT on ChassisTimeSynchronizationSetting Policy. )' : value: id: timesynchronizationsettingsUUID2 isNtpFromMgmtCentre: true ntpServers: - id: ntpServerObjectUUID1 name: ntpServerObjectName1 type: ntpServerObject type: ChassisTimeSynchronizationSetting schema: $ref: '#/components/schemas/ChassisTimeSynchronizationSetting' type: object description: Input representation of time synchronization settings policy. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timesynchronizationsettings/timesynchronizationsettingsUUID2 ( Example payload for PUT on ChassisTimeSynchronizationSetting Policy. )' : value: id: timesynchronizationsettingsUUID2 isNtpFromMgmtCentre: true links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timesynchronizationsettings/timesynchronizationsettingsUUID2 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain timestamp: 1640170486880.0 ntpServers: - id: ntpServerObjectUUID1 name: ntpServerObjectName1 type: ntpServerObject type: ChassisTimeSynchronizationSetting schema: $ref: '#/components/schemas/ChassisTimeSynchronizationSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings: get: deprecated: false description: '**Get all time zone settings policies for a particular chassis platform settings policy.**' operationId: getAllChassisTimeZoneSetting parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings ( Example payload for GET on ChassisTimeZoneSetting Policy )' : value: items: - id: timezonesettingsUUID links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timezonesettings/timezonesettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 timeZone: id: Etc/GMT+12 type: GlobalTimeZone type: ChassisTimeZoneSetting links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timezonesettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings ( Example payload for GET on ChassisTimeZoneSetting Policy )' : value: items: - id: timezonesettingsUUID links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timezonesettings/timezonesettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 timeZone: id: Etc/GMT+12 type: GlobalTimeZone type: ChassisTimeZoneSetting links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timezonesettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/ChassisTimeZoneSettingListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings/{objectId} : get: deprecated: false description: '**Get the time zone settings policy associated with the specified ID for a particular chassis platform settings policy.**' operationId: getChassisTimeZoneSetting parameters: - description: Unique identifier of the time zone settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings ( Example payload for GET on ChassisTimeZoneSetting Policy )' : value: items: - id: timezonesettingsUUID links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timezonesettings/timezonesettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 timeZone: id: Etc/GMT+12 type: GlobalTimeZone type: ChassisTimeZoneSetting links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timezonesettings?offset=0&limit=25&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/timezonesettings/timezonesettingsUUID ( Example payload for GET on ChassisTimeZoneSetting policy )' : value: id: timezonesettingsUUID links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timezonesettings/timezonesettingsUUID metadata: domain: id: domainUUID name: Global type: Domain timestamp: 1639639589846.0 timeZone: id: Etc/GMT+12 type: GlobalTimeZone type: ChassisTimeZoneSetting schema: $ref: '#/components/schemas/ChassisTimeZoneSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the time zone settings policy associated with the specified ID for a particular chassis platform settings policy. _Check the response section for applicable examples (if any)._**' operationId: updateChassisTimeZoneSetting parameters: - description: Unique identifier of the time zone settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timezonesettings/timezonesettingsUUID2 ( Example payload for PUT on ChassisTimeZoneSetting Policy. )' : value: id: timezonesettingsUUID2 timeZone: id: Etc/GMT+12 type: GlobalTimeZone type: ChassisTimeZoneSetting schema: $ref: '#/components/schemas/ChassisTimeZoneSetting' type: object description: Input representation of time zone settings policy. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timezonesettings/timezonesettingsUUID2 ( Example payload for PUT on ChassisTimeZoneSetting Policy. )' : value: id: timezonesettingsUUID2 links: self: /api/fmc_config/v1/domain/domainUUID/policy/chassisplatformsettingspolicies/containerUUID/timezonesettings/timezonesettingsUUID2 metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain timestamp: 1640170486880.0 timeZone: id: Etc/GMT+12 type: GlobalTimeZone type: ChassisTimeZoneSetting schema: $ref: '#/components/schemas/ChassisTimeZoneSetting' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{objectId}: delete: deprecated: false description: '**Delete the chassis platform settings policies associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteChassisPlatformSettingsPolicy parameters: - description: Unique identifier of the chassis platform settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid1 ( Example payload for DELETE on chassis platform settings policy. )' : value: description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid1 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid1 name: chassis platform settings policy1 type: ChassisPlatformSettingsPolicy schema: $ref: '#/components/schemas/ChassisPlatformSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the chassis platform settings policies associated with the specified ID.**' operationId: getChassisPlatformSettingsPolicy parameters: - description: Unique identifier of the chassis platform settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies ( Example payloads for GET listing on chassis platform settings policy. )' : value: items: - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid1 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid1 name: chassis platform settings policy1 type: ChassisPlatformSettingsPolicy - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid2 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid2 name: chassis platform settings policy2 type: ChassisPlatformSettingsPolicy links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GETALL /api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies?expanded=true ( Example payload for GET on chassis platform settings policy with expanded=true )' : value: items: - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid1 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid1 name: chassis platform settings policy1 type: ChassisPlatformSettingsPolicy - description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid2 links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid2 name: chassis platform settings policy2 type: ChassisPlatformSettingsPolicy links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies?offset=0&limit=2&expanded=true paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 3 : GET /api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid ( Example payloads for GET on chassis platform settings policy. )' : value: description: chassis platform settings policy for testing rest API id: ChassisPlatformSettingsPolicyUuid links: self: https://fmc_host_ip/api/fmc_config/v1/domain/DomainUUID/policy/chassisplatformsettingspolicies/ChassisPlatformSettingsPolicyUuid name: chassis platform settings policy type: ChassisPlatformSettingsPolicy schema: $ref: '#/components/schemas/ChassisPlatformSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the chassis platform settings policies associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateChassisPlatformSettingsPolicy parameters: - description: Unique identifier of the chassis platform settings policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/ChassisPlatformSettingsPolicy' type: object description: The input chassis platform settings policy required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ChassisPlatformSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies: get: deprecated: false description: '**Get the list of all decryption policies.**' operationId: getAllDecryptionPolicy parameters: - description: Filter by name of the decryption policy. in: query name: filter required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies?limit=2 ( Get all decryption policies with limit set to 2 )' : value: items: - id: 969ef100-c656-11ec-a35d-30484f453c53 name: test_policy_42_modified type: DecryptionPolicy - id: ff9bc964-c5e6-11ec-9e05-a1814f453c53 name: test_policy_47 type: DecryptionPolicy links: self: https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=0&limit=2 paging: count: 6 limit: 2 next: - https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=2&limit=2 - https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=4&limit=2 offset: 0 pages: 3 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies?limit=2&expanded=true ( Get all decryption policies with limit set to 2 and expanded set to true )' : value: items: - advancedOptions: adaptiveProbe: true blockExtensions: - 65846 disallowUntrustedIssuerResign: false quicDecryption: false stripHTTP3: true tls13Decryption: true defaultAction: eventLogAction: LOG_FLOW_END policyAction: BLOCK description: test_description_modified id: 969ef100-c656-11ec-a35d-30484f453c53 links: self: https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/969ef100-c656-11ec-a35d-30484f453c53 logging: logEnd: true sendEvents: true metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1651095681.0 name: test_policy_42_modified trustedCAs: objects: - id: 5f8dd758-ac46-36ff-bd83-48c6987228e7 name: Amazon-Root-CA-1 type: ExternalCACertificate - id: d3856136-b65c-49e6-ac4c-0daf5be98bc1 name: Cisco-Trusted-Authorities type: ExternalCACertificateGroup type: DecryptionPolicy undecryptableActions: compressedSession: INHERIT_DEFAULT_ACTION decryptionErrors: BLOCK handshakeErrors: INHERIT_DEFAULT_ACTION sessionNotCached: INHERIT_DEFAULT_ACTION sslV2Session: DO_NOT_DECRYPT unknownCipherSuite: INHERIT_DEFAULT_ACTION unsupportedCipherSuite: INHERIT_DEFAULT_ACTION - advancedOptions: adaptiveProbe: true blockExtensions: [] disallowUntrustedIssuerResign: true quicDecryption: false stripHTTP3: false tls13Decryption: false defaultAction: eventLogAction: LOG_NONE policyAction: DO_NOT_DECRYPT id: ff9bc964-c5e6-11ec-9e05-a1814f453c53 links: self: https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/ff9bc964-c5e6-11ec-9e05-a1814f453c53 logging: logEnd: false sendEvents: false metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1651035649.0 name: test_policy_47 trustedCAs: objects: - id: d3856136-b65c-49e6-ac4c-0daf5be98bc1 name: Cisco-Trusted-Authorities type: ExternalCACertificateGroup type: DecryptionPolicy undecryptableActions: compressedSession: INHERIT_DEFAULT_ACTION decryptionErrors: BLOCK handshakeErrors: INHERIT_DEFAULT_ACTION sessionNotCached: INHERIT_DEFAULT_ACTION sslV2Session: INHERIT_DEFAULT_ACTION unknownCipherSuite: INHERIT_DEFAULT_ACTION unsupportedCipherSuite: INHERIT_DEFAULT_ACTION links: self: https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=0&limit=2&expanded=true paging: count: 6 limit: 2 next: - https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=2&limit=2&expanded=true - https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=4&limit=2&expanded=true offset: 0 pages: 3 schema: $ref: '#/components/schemas/DecryptionPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create a decryption policy. _Check the response section for applicable examples (if any)._**' operationId: createDecryptionPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies ( Test creation of new Decryption Policy )': value: advancedOptions: adaptiveProbe: true blockExtensions: [] disallowUntrustedIssuerResign: true quicDecryption: false stripHTTP3: false tls13Decryption: false defaultAction: eventLogAction: LOG_NONE policyAction: DO_NOT_DECRYPT logging: logEnd: false sendEvents: false name: test_policy_51 trustedCAs: objects: - id: d3856136-b65c-49e6-ac4c-0daf5be98bc1 name: Cisco-Trusted-Authorities type: ExternalCACertificateGroup undecryptableActions: compressedSession: INHERIT_DEFAULT_ACTION decryptionErrors: BLOCK handshakeErrors: INHERIT_DEFAULT_ACTION sessionNotCached: INHERIT_DEFAULT_ACTION sslV2Session: INHERIT_DEFAULT_ACTION unknownCipherSuite: INHERIT_DEFAULT_ACTION unsupportedCipherSuite: INHERIT_DEFAULT_ACTION schema: $ref: '#/components/schemas/DecryptionPolicy' type: object description: Input representation of decryption policy object. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies ( Test creation of new Decryption Policy )': value: advancedOptions: adaptiveProbe: true blockExtensions: [] disallowUntrustedIssuerResign: true quicDecryption: false stripHTTP3: false tls13Decryption: false defaultAction: eventLogAction: LOG_NONE policyAction: DO_NOT_DECRYPT id: 939410fc-c64d-11ec-91c1-31484f453c53 links: self: https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/939410fc-c64d-11ec-91c1-31484f453c53 logging: logEnd: false sendEvents: false metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1651097729.0 name: test_policy_51 trustedCAs: groups: - id: d3856136-b65c-49e6-ac4c-0daf5be98bc1 name: Cisco-Trusted-Authorities type: ExternalCACertificateGroup literals: [] objects: [] type: DecryptionPolicy undecryptableActions: compressedSession: INHERIT_DEFAULT_ACTION decryptionErrors: BLOCK handshakeErrors: INHERIT_DEFAULT_ACTION sessionNotCached: INHERIT_DEFAULT_ACTION sslV2Session: INHERIT_DEFAULT_ACTION unknownCipherSuite: INHERIT_DEFAULT_ACTION unsupportedCipherSuite: INHERIT_DEFAULT_ACTION schema: $ref: '#/components/schemas/DecryptionPolicy' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules: get: deprecated: false description: '**Get the list of all decryption policy rules.**' operationId: getAllDecryptionPolicyRule parameters: - description: Filter by full text search over all rule attributes. in: query name: filter required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules?limit=2 ( Get all decryption policy rules with limit set to 2 )' : value: items: - id: 969ef100-c656-11ec-a35d-30484f453c53 name: test_rule_1 type: DecryptionPolicyRule - id: ff9bc964-c5e6-11ec-9e05-a1814f453c53 name: test_rule_2 type: DecryptionPolicyRule links: self: https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/containerUUID/decryptionpolicyrules?offset=0&limit=2 paging: count: 6 limit: 2 next: - https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/offset=2&limit=2 - https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/offset=4&limit=2 offset: 0 pages: 3 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules?limit=2&filter=fts:rule1 ( Get all decryption policy rules with limit set to 2 and fts(full text search) applied )' : value: items: - id: 969ef100-c656-11ec-a35d-30484f453c53 name: test_rule_1 type: DecryptionPolicyRule links: self: https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/containerUUID/decryptionpolicyrules?offset=0&limit=2 paging: count: 1 limit: 2 offset: 0 pages: 1 ? 'Example 3 : GET /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules?limit=2&expanded=true ( Get all decryption policy rules with limit set to 2 and expanded set to true )' : value: items: - applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH decryptionCerts: objects: - id: 395027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_1 type: InternalCA destinationNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: '51' name: Armenia type: Country - id: dde11d62-288b-4b4c-92e0-1dad0496f14b name: any-ipv6 overridable: false type: Network - id: 00000000-0000-0ed3-0001-245540515930 name: nw1 overridable: false type: Network - id: 00000000-0000-0ed3-0001-284195221566 name: test1 overridable: false type: Network destinationPorts: literals: - port: '123' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0001-318554959875 name: custom_1 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone1 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: standard_category ruleIndex: 1 name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: ffffffff-3847-2947-1294-000000000002 name: Antarctica type: Continent - id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 overridable: false type: Network - id: 00000000-0000-0ed3-0001-245540515843 name: host1 overridable: false type: Host - id: 00000000-0000-0ed3-0001-245540515869 name: range1 overridable: false type: Range sourcePorts: objects: - id: 1834e5f0-38bb-11e2-86aa-62f0c593a59a name: Bittorrent overridable: false protocol: TCP type: ProtocolPortObject - id: 1834c674-38bb-11e2-86aa-62f0c593a59a name: FTP overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone1 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '1' name: group1 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '1' name: user1 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '2' objects: - id: 00000000-0000-0ed3-0000-034359739010 name: tag1 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739046 name: tag_group_1 type: VlanTagGroup - applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: '51' name: Armenia type: Country - id: dde11d62-288b-4b4c-92e0-1dad0496f14b name: any-ipv6 overridable: false type: Network - id: 00000000-0000-0ed3-0001-245540515930 name: nw1 overridable: false type: Network - id: 00000000-0000-0ed3-0001-284195221566 name: test1 overridable: false type: Network destinationPorts: literals: - port: '123' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0001-318554959875 name: custom_1 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone1 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 46c67e70-d302-11ec-a4b5-8688e0efad1c internalCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 name: internal_cert_1 type: InternalCertificate issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: standard_category ruleIndex: 2 name: rule2 ruleAction: DECRYPT_KNOWN_KEY sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: ffffffff-3847-2947-1294-000000000002 name: Antarctica type: Continent - id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 overridable: false type: Network - id: 00000000-0000-0ed3-0001-245540515843 name: host1 overridable: false type: Host - id: 00000000-0000-0ed3-0001-245540515869 name: range1 overridable: false type: Range sourcePorts: objects: - id: 1834e5f0-38bb-11e2-86aa-62f0c593a59a name: Bittorrent overridable: false protocol: TCP type: ProtocolPortObject - id: 1834c674-38bb-11e2-86aa-62f0c593a59a name: FTP overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone1 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '1' name: group1 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '1' name: user1 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '2' objects: - id: 00000000-0000-0ed3-0000-034359739010 name: tag1 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739046 name: tag_group_1 type: VlanTagGroup links: self: https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/containerUUID/decryptionpolicyrules?offset=0&limit=2&expanded=true paging: count: 6 limit: 2 next: - https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/offset=2&limit=2&expanded=true - https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/offset=4&limit=2&expanded=true offset: 0 pages: 3 schema: $ref: '#/components/schemas/DecryptionPolicyRuleListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create a decryption policy rule. _Check the response section for applicable examples (if any)._**' operationId: createMultipleDecryptionPolicyRule parameters: - description: Enables bulk creation of decryption policy rules. in: query name: bulk required: false schema: type: boolean - description: Specifies that the rule will be inserted after the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply. in: query name: insertAfter required: false schema: type: number - description: Specifies that the rule will be inserted before the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply. in: query name: insertBefore required: false schema: type: number - description: Specifies the category into which the rule will be added. If a category is specified it must exist or the request will fail. in: query name: category required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules ( Test creation of new Decryption Policy Rule )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH decryptionCerts: objects: - id: 395027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_1 type: InternalCA destinationNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: '51' name: Armenia type: Country - id: dde11d62-288b-4b4c-92e0-1dad0496f14b name: any-ipv6 overridable: false type: Network - id: 00000000-0000-0ed3-0001-245540515930 name: nw1 overridable: false type: Network - id: 00000000-0000-0ed3-0001-284195221566 name: test1 overridable: false type: Network destinationPorts: literals: - port: '123' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0001-318554959875 name: custom_1 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone1 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: ffffffff-3847-2947-1294-000000000002 name: Antarctica type: Continent - id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 overridable: false type: Network - id: 00000000-0000-0ed3-0001-245540515843 name: host1 overridable: false type: Host - id: 00000000-0000-0ed3-0001-245540515869 name: range1 overridable: false type: Range sourcePorts: objects: - id: 1834e5f0-38bb-11e2-86aa-62f0c593a59a name: Bittorrent overridable: false protocol: TCP type: ProtocolPortObject - id: 1834c674-38bb-11e2-86aa-62f0c593a59a name: FTP overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone1 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '1' name: group1 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '1' name: user1 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '2' objects: - id: 00000000-0000-0ed3-0000-034359739010 name: tag1 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739046 name: tag_group_1 type: VlanTagGroup ? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?category=root_category ( Test POST of rule with category specified )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: MEDIUM decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 3 : POST /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?insertBefore=3 ( Test POST of Decryption Policy Rule with insert before index specified )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: MEDIUM decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 4 : POST /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?insertAfter=1 ( Test POST of Decryption Policy Rule with insert after index specified )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: VERY_HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup schema: $ref: '#/components/schemas/DecryptionPolicyRule' type: object description: Input representation of decryption policy rule object. required: true responses: '201': content: application/json: examples: ? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?category=root_category ( Test POST of rule with category specified )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: VERY_HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: root_category ruleIndex: 2 name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 3 : POST /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?insertBefore=3 ( Test POST of Decryption Policy Rule with insert before index specified )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: VERY_HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: standard_category ruleIndex: 3 name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 4 : POST /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?insertAfter=1 ( Test POST of Decryption Policy Rule with insert after index specified )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: VERY_HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: root_category ruleIndex: 2 name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup schema: $ref: '#/components/schemas/DecryptionPolicyRule' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{containerUUID}/decryptionpolicyrules/{objectId}: delete: deprecated: false description: '**Delete the decryption policy rule associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteDecryptionPolicyRule parameters: - description: Unique identifier of the decryption policy rule. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/939410fc-c64d-11ec-91c1-31484f453c53/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c ( Test DELETE of Decryption Policy Rule )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: MEDIUM decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: root_category ruleIndex: 2 name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup schema: $ref: '#/components/schemas/DecryptionPolicyRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the decryption policy rule associated with the specified ID.**' operationId: getDecryptionPolicyRule parameters: - description: Unique identifier of the decryption policy rule. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c ( Get Decryption Policy Rule by id )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH decryptionCerts: objects: - id: 395027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_1 type: InternalCA destinationNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: '51' name: Armenia type: Country - id: dde11d62-288b-4b4c-92e0-1dad0496f14b name: any-ipv6 overridable: false type: Network - id: 00000000-0000-0ed3-0001-245540515930 name: nw1 overridable: false type: Network - id: 00000000-0000-0ed3-0001-284195221566 name: test1 overridable: false type: Network destinationPorts: literals: - port: '123' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0001-318554959875 name: custom_1 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone1 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: standard_category ruleIndex: 1 name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: ffffffff-3847-2947-1294-000000000002 name: Antarctica type: Continent - id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 overridable: false type: Network - id: 00000000-0000-0ed3-0001-245540515843 name: host1 overridable: false type: Host - id: 00000000-0000-0ed3-0001-245540515869 name: range1 overridable: false type: Range sourcePorts: objects: - id: 1834e5f0-38bb-11e2-86aa-62f0c593a59a name: Bittorrent overridable: false protocol: TCP type: ProtocolPortObject - id: 1834c674-38bb-11e2-86aa-62f0c593a59a name: FTP overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone1 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '1' name: group1 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '1' name: user1 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '2' objects: - id: 00000000-0000-0ed3-0000-034359739010 name: tag1 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739046 name: tag_group_1 type: VlanTagGroup schema: $ref: '#/components/schemas/DecryptionPolicyRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modifies the decryption policy rule associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateDecryptionPolicyRule parameters: - description: Unique identifier of the decryption policy rule. in: path name: objectId required: true schema: type: string - description: Specifies that the rule will be inserted after the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply. in: query name: insertAfter required: false schema: type: number - description: Specifies that the rule will be inserted before the specified rule index. insertBefore takes precedence over insertAfter - if both are specified, the insertBefore parameter will apply. in: query name: insertBefore required: false schema: type: number - description: Specifies the category into which the rule will be added. If a category is specified it must exist or the request will fail. in: query name: category required: false schema: type: string - description: This field specifies whether to change the entire object or only certain attributes of it. When its value is false the whole object will change, and if the value is true then only the attributes that are specified will change. The default value of this field is false. in: query name: partialUpdate required: false schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c ( Test PUT of Decryption Policy Rule to update various fields )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: VERY_HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?category=root_category ( Test PUT of Decryption Policy Rule to update the rule category )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 3 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?insertBefore=3 ( Test PUT of Decryption Policy Rule to move the rule right before some specific index )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 4 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?insertAfter=1 ( Test PUT of Decryption Policy Rule to move the rule right after some specific index )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 5 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?partialUpdate=true ( Test PUT of Decryption Policy Rule with partialUpdate set to true )' : value: certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' clientThreat: MEDIUM destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject id: 36c67e70-d302-11ec-a4b5-8688e0efad1c name: rule1 sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule schema: $ref: '#/components/schemas/DecryptionPolicyRule' type: object description: Input representation of decryption policy rule object to be updated. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c ( Test PUT of Decryption Policy Rule to update various fields )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: VERY_HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?category=root_category ( Test PUT of Decryption Policy Rule to update the rule category )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: root_category ruleIndex: 2 name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 3 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?insertBefore=3 ( Test PUT of Decryption Policy Rule to move the rule right before some specific index )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: standard_category ruleIndex: 3 name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 4 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?insertAfter=1 ( Test PUT of Decryption Policy Rule to move the rule right after some specific index )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH decryptionCerts: objects: - id: 495027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_2 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: root_category ruleIndex: 2 name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup ? 'Example 5 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/containerUUID/decryptionpolicyrules/36c67e70-d302-11ec-a4b5-8688e0efad1c?partialUpdate=true ( Test PUT of Decryption Policy Rule with partialUpdate set to true )' : value: applications: applications: - id: '2325' name: 050plus type: Application - id: '1205' name: 12306.cn type: Application - id: '4164' name: 123Movies type: Application inlineApplicationFilters: - applicationTypes: - id: CLIENT name: Client Application type: ApplicationType categories: - id: '28' name: collaboration type: ApplicationCategory productivities: - id: MEDIUM name: Medium type: ApplicationProductivity risks: - id: VERY_LOW name: Very Low type: ApplicationRisk tags: - id: '111' name: edonkey type: ApplicationTag certStatuses: expired: 'yes' invalidCRL: 'yes' invalidCertificate: 'no' invalidIssuer: 'yes' invalidSignature: 'no' notYetValid: 'no' revoked: 'yes' selfSigned: 'yes' serverMismatch: any valid: 'no' cipherSuites: literals: - name: PCT_SSL_EXCH_TYPE type: CipherSuiteLiteral value: '8519681' - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList objects: - id: c8924358-fd77-11ec-b858-ec2f7dc1dc7e name: ciphersuite_obj_1 type: CipherSuiteList clientThreat: HIGH decryptionCerts: objects: - id: 395027da-9c12-11ec-b407-2bbe55c5f4d0 isCSR: false name: import_CA_1 type: InternalCA destinationNetworks: literals: - type: Host value: 1.2.3.4 objects: - id: 00000000-0000-0ed3-0002-245540515930 name: nw2 overridable: false type: Network - id: 00000000-0000-0ed3-0002-284195221566 name: test2 overridable: false type: Network destinationPorts: literals: - port: '567' protocol: '6' type: PortLiteral objects: - id: 00000000-0000-0ed3-0002-318554959875 name: custom_2 overridable: false protocol: TCP type: ProtocolPortObject destinationZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone enabled: true externalCertificates: - id: 76a47fc4-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_1 type: ExternalCertificate - id: 82da03b8-fd73-11ec-b858-ec2f7dc1dc7e name: external_cert_group_1 type: ExternalCertificateGroup id: 36c67e70-d302-11ec-a4b5-8688e0efad1c issuerDNs: literals: - type: DistinguishedNameLiteral value: CN=abc1 objects: - id: 12c0d3d1-b6eb-32c5-93cd-f693ff1237de name: CN_.core.windows.net type: DistinguishedName - id: 56d71648-91f6-47d3-b3f3-f92148089cd0 name: Cisco-Undecryptable-Sites type: DistinguishedNameGroup logging: logEnd: true sendEvents: false metadata: category: name: root_category ruleIndex: 2 name: rule1 ruleAction: DECRYPT_RESIGN sourceNetworks: literals: - type: Host value: 5.6.7.8 objects: - id: 00000000-0000-0ed3-0002-245540515843 name: host2 overridable: false type: Host - id: 00000000-0000-0ed3-0002-245540515869 name: range2 overridable: false type: Range sourcePorts: objects: - id: 00000000-0000-0ed3-0002-322849927189 name: tcp2 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0003-322849927189 name: tcp3 overridable: false protocol: TCP type: ProtocolPortObject - id: 00000000-0000-0ed3-0001-322849927189 name: tcp1 overridable: false protocol: TCP type: ProtocolPortObject sourceZones: objects: - id: 387cfc68-fd4f-11ec-bd74-f801fd48cd9d name: zone2 type: SecurityZone subjectDNs: literals: - type: DistinguishedNameLiteral value: CN=abc2 objects: - id: 200f951c-285c-301e-bee7-fc5332eb7c16 name: CN_.apps.apple.com type: DistinguishedName - id: 1f26c7fa-fd75-11ec-b858-ec2f7dc1dc7e name: group1 type: DistinguishedNameGroup tlsVersions: sslv3: false tls10: true tls11: false tls12: true tls13: true type: DecryptionPolicyRule urls: urlCategoriesWithReputation: - category: id: abba9b63-bb10-4729-b901-2e2aa0f02006 name: Adult type: URLCategory reputation: TRUSTED_AND_UNKNOWN type: UrlCategoryAndReputation users: objects: - id: '2' name: group2 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUserGroup - id: '3' name: user3 realm: id: 33a0c2c20-dc18-11ea-87dc-a4f73ca0df49 type: Realm type: RealmUser vlanTags: literals: - type: VlanTagLiteral value: '3' objects: - id: 00000000-0000-0ed3-0000-034359749010 name: tag2 type: VlanTag - id: 00000000-0000-0ed3-0000-034359739047 name: tag_group_2 type: VlanTagGroup schema: $ref: '#/components/schemas/DecryptionPolicyRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies/{objectId}: delete: deprecated: false description: '**Delete the decryption policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteDecryptionPolicy parameters: - description: Unique identifier of the decryption policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/939410fc-c64d-11ec-91c1-31484f453c53 ( Test DELETE of Decryption Policy )' : value: advancedOptions: adaptiveProbe: true blockExtensions: [] disallowUntrustedIssuerResign: true quicDecryption: false stripHTTP3: false tls13Decryption: false defaultAction: eventLogAction: LOG_NONE policyAction: DO_NOT_DECRYPT id: 939410fc-c64d-11ec-91c1-31484f453c53 links: self: https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/939410fc-c64d-11ec-91c1-31484f453c53 logging: logEnd: false sendEvents: false metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1651097729.0 name: test_policy_51 trustedCAs: objects: - id: d3856136-b65c-49e6-ac4c-0daf5be98bc1 name: Cisco-Trusted-Authorities type: ExternalCACertificateGroup type: DecryptionPolicy undecryptableActions: compressedSession: INHERIT_DEFAULT_ACTION decryptionErrors: BLOCK handshakeErrors: INHERIT_DEFAULT_ACTION sessionNotCached: INHERIT_DEFAULT_ACTION sslV2Session: INHERIT_DEFAULT_ACTION unknownCipherSuite: INHERIT_DEFAULT_ACTION unsupportedCipherSuite: INHERIT_DEFAULT_ACTION schema: $ref: '#/components/schemas/DecryptionPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the decryption policy associated with the specified ID.**' operationId: getDecryptionPolicy parameters: - description: Unique identifier of the decryption policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/969ef100-c656-11ec-a35d-30484f453c53 ( Get DecryptionPolicy by id )' : value: advancedOptions: adaptiveProbe: true blockExtensions: - 65846 disallowUntrustedIssuerResign: false quicDecryption: false stripHTTP3: true tls13Decryption: true defaultAction: eventLogAction: LOG_FLOW_END policyAction: BLOCK description: test_description_modified id: 969ef100-c656-11ec-a35d-30484f453c53 links: self: https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/969ef100-c656-11ec-a35d-30484f453c53 logging: logEnd: true sendEvents: true metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1651095681.0 name: test_policy_42_modified trustedCAs: objects: - id: 5f8dd758-ac46-36ff-bd83-48c6987228e7 name: Amazon-Root-CA-1 type: ExternalCACertificate - id: d3856136-b65c-49e6-ac4c-0daf5be98bc1 name: Cisco-Trusted-Authorities type: ExternalCACertificateGroup type: DecryptionPolicy undecryptableActions: compressedSession: INHERIT_DEFAULT_ACTION decryptionErrors: BLOCK handshakeErrors: INHERIT_DEFAULT_ACTION sessionNotCached: INHERIT_DEFAULT_ACTION sslV2Session: DO_NOT_DECRYPT unknownCipherSuite: INHERIT_DEFAULT_ACTION unsupportedCipherSuite: INHERIT_DEFAULT_ACTION schema: $ref: '#/components/schemas/DecryptionPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the decryption policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateDecryptionPolicy parameters: - description: Unique identifier of the decryption policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/32b6b798-c81f-11ec-8bc6-23a776919dc8 ( Test PUT of Decryption Policy to update various fields )' : value: advancedOptions: adaptiveProbe: true blockExtensions: - 65846 disallowUntrustedIssuerResign: false quicDecryption: false stripHTTP3: true tls13Decryption: true defaultAction: eventLogAction: LOG_NONE policyAction: DO_NOT_DECRYPT id: 32b6b798-c81f-11ec-8bc6-23a776919dc8 links: self: https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/32b6b798-c81f-11ec-8bc6-23a776919dc8 logging: logEnd: true sendEvents: true name: test_policy_9 trustedCAs: objects: - id: d3856136-b65c-49e6-ac4c-0daf5be98bc1 name: Cisco-Trusted-Authorities type: ExternalCACertificateGroup type: DecryptionPolicy undecryptableActions: compressedSession: INHERIT_DEFAULT_ACTION decryptionErrors: BLOCK handshakeErrors: INHERIT_DEFAULT_ACTION sessionNotCached: INHERIT_DEFAULT_ACTION sslV2Session: INHERIT_DEFAULT_ACTION unknownCipherSuite: INHERIT_DEFAULT_ACTION unsupportedCipherSuite: INHERIT_DEFAULT_ACTION schema: $ref: '#/components/schemas/DecryptionPolicy' type: object description: Input representation of decryption policy object to be updated. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies/32b6b798-c81f-11ec-8bc6-23a776919dc8 ( Test PUT of Decryption Policy to update various fields )' : value: advancedOptions: adaptiveProbe: true blockExtensions: - 65846 disallowUntrustedIssuerResign: false quicDecryption: false stripHTTP3: true tls13Decryption: true defaultAction: eventLogAction: LOG_FLOW_END policyAction: DO_NOT_DECRYPT id: 32b6b798-c81f-11ec-8bc6-23a776919dc8 links: self: https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/32b6b798-c81f-11ec-8bc6-23a776919dc8 logging: logEnd: true sendEvents: true metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: name: admin timestamp: 1651510075.0 name: test_policy_9 trustedCAs: objects: - id: d3856136-b65c-49e6-ac4c-0daf5be98bc1 name: Cisco-Trusted-Authorities type: ExternalCACertificateGroup type: DecryptionPolicy undecryptableActions: compressedSession: INHERIT_DEFAULT_ACTION decryptionErrors: BLOCK handshakeErrors: INHERIT_DEFAULT_ACTION sessionNotCached: INHERIT_DEFAULT_ACTION sslV2Session: INHERIT_DEFAULT_ACTION unknownCipherSuite: INHERIT_DEFAULT_ACTION unsupportedCipherSuite: INHERIT_DEFAULT_ACTION schema: $ref: '#/components/schemas/DecryptionPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies: get: deprecated: false description: '**Get all DNS policies.**' operationId: getAllDNSPolicy parameters: - description: Filter criteria can be specified using the format name:policy_name

policy_name -- Name of the DNS Policy to be queried. in: query name: filter required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/dnspolicies?expanded=true ( Get all paginated DNS policy objects )' : value: items: - description: default DNS Policy id: dnspolicyUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID name: Default DNS Policy type: DNSPolicy - description: test DNS Policy id: dnspolicyUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID name: test DNS Policy type: DNSPolicy - description: Blocklist DNS Policy id: dnspolicyUUID links: self: /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID name: DNS Blocklist Policy type: DNSPolicy links: self: api/fmc_config/v1/domain/DomainUUID/policy/dnspolicies?expanded=true&offset=0&limit=3 paging: count: '3' limit: '3' offset: '0' pages: '1' schema: $ref: '#/components/schemas/DNSPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies/{containerUUID}/allowdnsrules: get: deprecated: false description: '**Get the allow rules for a DNS policy.**' operationId: getAllowDNSRule parameters: - description: Filter criteria can be specified using the format name:rule_name

name -- Name of the allow rule to be queried
in: query name: filter required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/allowdnsrules?expanded=false&offset=0&limit=2 ( Get all paginated DNS Policy Allow Rules for a given DNS Policy UUID with limit set to 2 )' : value: items: - action: ALLOW name: DNSRuleName type: AllowDNSRule - action: ALLOW name: DNSRuleName type: AllowDNSRule links: self: /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/allowdnsrules?expanded=false&offset=0&limit=2 paging: count: '2' limit: '2' offset: '0' pages: '1' ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/allowdnsrules?expanded=true&offset=0&limit=1 ( Get all paginated DNS Policy Allow Rules for a given DNS Policy UUID with limit set to 1 and expanded true )' : value: items: - action: ALLOW dnsLists: objects: - id: SIDNSListUUID links: self: /fmc_config/v1/domain/DomainUUID/object/sidnslists/SIDNSListUUID name: Global-Do-Not-Block-List-for-DNS type: SIDNSList enabled: true metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false ruleIndex: 0 timestamp: 1601994796.0 name: Global-Do-Not-Block-List-for-DNS systemDefault: true type: AllowDNSRule links: self: /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/allowdnsrules?expanded=true&offset=0&limit=1 paging: count: '1' limit: '1' offset: '0' pages: '1' schema: $ref: '#/components/schemas/AllowDNSRuleListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies/{containerUUID}/blockdnsrules: get: deprecated: false description: '**Get the block rules for a DNS policy.**' operationId: getBlockDNSRule parameters: - description: Filter criteria can be specified using the format name:rule_name

name -- Name of the block rule to be queried
in: query name: filter required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/blockdnsrules?expanded=false&offset=0&limit=2 ( Get all paginated DNS Policy Block Rules for a given DNS Policy UUID with limit set to 2 )' : value: items: - action: NXDOMAIN name: DNSRuleName type: BlockDNSRule - action: NXDOMAIN name: DNSRuleName type: BlockDNSRule links: self: /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/blockdnsrules?expanded=false&offset=0&limit=2 paging: count: '2' limit: '2' offset: '0' pages: '1' ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/blockdnsrules?expanded=true&offset=0&limit=1 ( Get all paginated DNS Policy Block Rules for a given DNS Policy UUID with limit set to 1 and expanded true )' : value: items: - action: NXDOMAIN dnsLists: objects: - id: SIDNSListUUID links: self: /fmc_config/v1/domain/DomainUUID/object/sidnslists/SIDNSListUUID name: Global Blocklist for DNS type: SIDNSList enabled: true metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false ruleIndex: 4 timestamp: 1601994796.0 name: Global Blocklist for DNS systemDefault: true type: BlockDNSRule links: self: /fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID/blockdnsrules?expanded=true&offset=0&limit=1 paging: count: 1 limit: 1 offset: 0 pages: 1 schema: $ref: '#/components/schemas/BlockDNSRuleListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/dnspolicies/{objectId}: get: deprecated: false description: '**Get the DNS policy associated with the specified ID.**' operationId: getDNSPolicy parameters: - description: Unique identifier of the DNS policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID ( Test GET of DNS Policy )': value: description: Default DNS Policy id: dnspolicyUUID links: self: /api/fmc_config/v1/domain/DomainUUID/policy/dnspolicies/dnspolicyUUID metadata: domain: id: domainUUID name: Global type: Domain lastUser: id: userUUID name: admin type: User readOnly: state: true name: Default DNS Policy type: DNSPolicy schema: $ref: '#/components/schemas/DNSPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/dynamicaccesspolicies: get: deprecated: false description: '**Get the list of all dynamic access policies.**' operationId: getAllDynamicAccessPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: schema: $ref: '#/components/schemas/DynamicAccessPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create a dynamic access policy. _Check the response section for applicable examples (if any)._**' operationId: createDynamicAccessPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/DynamicAccessPolicy' type: object description: Input representation of Dynamic Access Policy. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/DynamicAccessPolicy' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/dynamicaccesspolicies/{objectId}: delete: deprecated: false description: '**Delete the dynamic access policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteDynamicAccessPolicy parameters: - description: Unique identifier of the dynamic access policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: schema: $ref: '#/components/schemas/DynamicAccessPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the dynamic access policy associated with the specified ID.**' operationId: getDynamicAccessPolicy parameters: - description: Unique identifier of the dynamic access policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: schema: $ref: '#/components/schemas/DynamicAccessPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the dynamic access policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateDynamicAccessPolicy parameters: - description: Unique identifier of the dynamic access policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/DynamicAccessPolicy' type: object description: Input representation of Dynamic Access Policy. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DynamicAccessPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies: get: deprecated: false description: '**Get the list of all file policies.**' operationId: getAllFilePolicy parameters: - description: Boolean indicating whether to include SSE-owned File policies. in: query name: includeSseOwned required: false schema: type: boolean - description: Boolean indicating whether to return only SSE-owned file policies. in: query name: onlySseOwned required: false schema: type: boolean - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: 'Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/filepolicies ( Success: Test GET ALL success )': value: items: - id: File-policy-UUID-1 links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-1 name: Test-TestDomain type: FilePolicy - id: File-policy-UUID-2 links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-2 name: Test-GlobalDomain type: FilePolicy links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/policy/filepolicies?expanded=true ( Success: Test GET ALL success with expanded=true )' : value: items: - description: Test-TestDomain id: File-policy-UUID-1 links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-1 metadata: domain: id: domainUUID name: TestDomain type: domain lastUser: id: User-UUID name: admin type: user readOnly: state: true timestamp: 1460056664.0 name: Test-TestDomain type: FilePolicy - description: Test-GlobalDomain id: File-policy-UUID-2 links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-2 metadata: domain: id: Global-domain-UUID name: Global type: domain lastUser: id: User-UUID name: admin type: user readOnly: state: false timestamp: 1460057664.0 name: Test-GlobalDomain type: FilePolicy links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FilePolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create a file policy. _Check the response section for applicable examples (if any)._**' operationId: createFilePolicy parameters: - description: The ticket ID corresponding to which the configuration changes are done in: header name: ticket-id required: false schema: type: string - description: '[DEV ERROR: Missing description]' in: query name: commitId required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/policy/filepolicies ( Create a File policy )': value: archiveDepth: 3 archiveDepthAction: true blockEncryptedArchives: false cleanList: true customDetectionList: true description: An example File Policy firstTimeFileAnalysis: true inspectArchives: false name: Test-File-policy threatScore: High type: FilePolicy schema: $ref: '#/components/schemas/FilePolicy' type: object description: The input file policy model. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/policy/filepolicies ( Create a File policy )': value: archiveDepth: 3 archiveDepthAction: true blockEncryptedArchives: false cleanList: true customDetectionList: true description: An example File Policy firstTimeFileAnalysis: true id: File-policy-UUID-3 inspectArchives: false links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-3 metadata: domain: id: domainUUID name: TestDomain type: domain lastUser: id: User-UUID name: admin type: user readOnly: state: false timestamp: 1460056664.0 name: Test-File-policy threatScore: High type: FilePolicy schema: $ref: '#/components/schemas/FilePolicy' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules: get: deprecated: false description: '**Get the list of all file rules.**' operationId: getAllFileRuleModel parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules?limit=2&expanded=true ( Success: Test GET ALL success of all the file rules with expanded=true )' : value: items: - action: DETECT direction: ANY fileCategories: - id: '2' name: Archive type: FileCategory fileTypes: - id: '19' name: 7Z type: FileType id: exampleFileRuleId1 links: self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules/fileruleId metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false timestamp: 1673362666.0 protocol: ANY type: FileRule - action: DETECT direction: ANY fileCategories: - id: '2' name: Archive type: FileCategory fileTypes: - id: '19' name: 7Z type: FileType id: exampleFileRuleId2 links: self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules/fileruleId metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false timestamp: 1673362666.0 protocol: ANY type: FileRule links: self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules?limit=2&expanded=true paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules?limit=2&expanded=false ( Success: Test GET ALL success of all the file categories with expanded=false )' : value: items: - id: exampleFileRuleId links: self: https://u45c01p01-vrouter.cisco.com:6321/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/filepolicies/1a048a88-8ec4-11ed-acbf-ee690fe4b009/filerules/d200d3c7-267b-2c22-134a-000000000000 type: FileRule - id: exampleFileRuleId2 links: self: https://u45c01p01-vrouter.cisco.com:6321/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/filepolicies/1a048a88-8ec4-11ed-acbf-ee690fe4b009/filerules/d200d3c7-267b-2c22-134a-000000000000 type: FileRule links: self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules?limit=2&expanded=false paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FileRuleModelListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Modify all file rules. _Check the response section for applicable examples (if any)._**' operationId: createFileRuleModel parameters: - description: The ticket ID corresponding to which the configuration changes are done in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules ( Success: Test POST success of a file rule )' : value: action: DETECT direction: ANY fileCategories: - id: '2' name: Archive type: FileCategory fileTypes: - id: '19' name: 7Z type: FileType protocol: ANY schema: $ref: '#/components/schemas/FileRuleModel' type: object description: Request input of a file rule. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FileRuleModel' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{containerUUID}/filerules/{objectId}: delete: deprecated: false description: '**Delete the file rule associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteFileRuleModel parameters: - description: Unique identifier of the file rule. in: path name: objectId required: true schema: type: string - description: The ticket ID corresponding to which the configuration changes are done in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules/fileruleId ( Success: Test DELETE success of a file rule )' : value: action: DETECT direction: ANY fileCategories: - id: '2' name: Archive type: FileCategory fileTypes: - id: '19' name: 7Z type: FileType id: exampleFileRuleId links: self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules/fileruleId metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false timestamp: 1673362666.0 protocol: ANY type: FileRule schema: $ref: '#/components/schemas/FileRuleModel' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the file rule associated with the specified ID.**' operationId: getFileRuleModel parameters: - description: Unique identifier of the file rule. in: path name: objectId required: true schema: type: string - description: The ticket ID corresponding to which the configuration changes are done in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules/fileruleId ( Success: Test GET success of a file rule )' : value: action: DETECT direction: ANY fileCategories: - id: '2' name: Archive type: FileCategory fileTypes: - id: '19' name: 7Z type: FileType id: exampleFileRuleId links: self: https://example.com:443/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules/fileruleId metadata: domain: id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: Global type: Domain lastUser: id: 68d03c42-d9bd-11dc-89f2-b7961d42c462 name: admin type: user readOnly: state: false timestamp: 1673362666.0 protocol: ANY type: FileRule schema: $ref: '#/components/schemas/FileRuleModel' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the file rule associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateFileRuleModel parameters: - description: Unique identifier of the file rule. in: path name: objectId required: true schema: type: string - description: The ticket ID corresponding to which the configuration changes are done in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/policy/filepolicies/filepolicyUUID/filerules/fileruleId ( Success: Test PUT success of a file rule )' : value: action: DETECT direction: ANY fileCategories: - id: '2' name: Archive type: FileCategory fileTypes: - id: '19' name: 7Z type: FileType id: exampleFileRuleId protocol: ANY schema: $ref: '#/components/schemas/FileRuleModel' type: object description: Request input of a file rule. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FileRuleModel' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/filepolicies/{objectId}: delete: deprecated: false description: '**Delete the file policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteFilePolicy parameters: - description: Unique identifier of the file policy. in: path name: objectId required: true schema: type: string - description: The ticket ID corresponding to which the configuration changes are done in: header name: ticket-id required: false schema: type: string - description: '[DEV ERROR: Missing description]' in: query name: commitId required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/policy/filepolicies/File-policy-UUID-3 ( Delete a File Policy )': value: archiveDepth: 2 archiveDepthAction: true blockEncryptedArchives: false cleanList: true customDetectionList: true description: An example File Policy firstTimeFileAnalysis: true id: File-policy-UUID-3 inspectArchives: false links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-3 metadata: domain: id: domainUUID name: TestDomain type: domain lastUser: id: User-UUID name: admin type: user readOnly: state: false timestamp: 1460056664.0 name: Test-File-policy_edited threatScore: MEDIUM type: FilePolicy schema: $ref: '#/components/schemas/FilePolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the file policy associated with the specified ID.**' operationId: getFilePolicy parameters: - description: Unique identifier of the file policy. in: path name: objectId required: true schema: type: string - description: The ticket ID corresponding to which the configuration changes are done in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-1 ( Success: Test GET method for filepolicy )' : value: description: Test-TestDomain id: File-policy-UUID-1 links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-1 metadata: domain: id: domainUUID name: TestDomain type: domain lastUser: id: User-UUID name: admin type: user readOnly: state: true timestamp: 1460056664.0 name: Test-TestDomain type: FilePolicy schema: $ref: '#/components/schemas/FilePolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the file policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateFilePolicy parameters: - description: Unique identifier of the file policy. in: path name: objectId required: true schema: type: string - description: The ticket ID corresponding to which the configuration changes are done in: header name: ticket-id required: false schema: type: string - description: '[DEV ERROR: Missing description]' in: query name: commitId required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/policy/filepolicies/File-policy-UUID-3 ( Update a File Policy )': value: archiveDepth: 2 archiveDepthAction: true blockEncryptedArchives: false cleanList: true customDetectionList: true description: An example File Policy firstTimeFileAnalysis: true id: File-policy-UUID-3 inspectArchives: false name: Test-File-policy_edited threatScore: MEDIUM type: FilePolicy schema: $ref: '#/components/schemas/FilePolicy' type: object description: Request input of a file policy. required: true responses: '200': content: application/json: examples: 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/policy/filepolicies/File-policy-UUID-3 ( Update a File Policy )': value: archiveDepth: 2 archiveDepthAction: true blockEncryptedArchives: false cleanList: true customDetectionList: true description: An example File Policy firstTimeFileAnalysis: true id: File-policy-UUID-3 inspectArchives: false links: self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/policy/filepolicies/File-policy-UUID-3 metadata: domain: id: domainUUID name: TestDomain type: domain lastUser: id: User-UUID name: admin type: user readOnly: state: false timestamp: 1460056664.0 name: Test-File-policy_edited threatScore: MEDIUM type: FilePolicy schema: $ref: '#/components/schemas/FilePolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/flexconfigpolicies: get: deprecated: false description: '**Get the list of all FlexConfig policies.**' operationId: getAllFlexConfig parameters: - description: Filter criteria can be specified using the format name:policy_name

policy_name -- Name of the FlexConfig Policy to be queried. in: query name: filter required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/flexconfigpolicies ( Test GET ALL of FlexConfig Policy )': value: items: - id: ObjectUUID links: self: https://example.cisco.com/api/fmc_config/v1/domain/DomainUUID/policy/flexconfigpolicies/ObjectUUID name: flex_config_test1 type: FlexConfigPolicy - id: ObjectUUID links: self: https://example.cisco.com/api/fmc_config/v1/domain/DomainUUID/policy/flexconfigpolicies/ObjectUUID name: flex_config_test2 type: FlexConfigPolicy links: self: https://example.cisco.com/api/fmc_config/v1/domain/DomainUUID/policy/flexconfigpolicies?offset=0&limit=25 paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FlexConfigListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create a FlexConfig policy. _Check the response section for applicable examples (if any)._**' operationId: createFlexConfig parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/FlexConfig' type: object description: The input for FlexConfig Policy. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FlexConfig' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/flexconfigpolicies/{containerUUID}/migrate: post: deprecated: false description: '**Initiate a FlexConfig migration for the specified devices. _Check the response section for applicable examples (if any)._**' operationId: createFlexConfigMigration parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/FlexConfigMigration' type: object description: The input migration model required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FlexConfigMigration' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/flexconfigpolicies/{objectId}: get: deprecated: false description: '**Get the FlexConfig Policy with the associated ID.**' operationId: getFlexConfig parameters: - description: Unique identifier of the FlexConfig policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/flexconfigpolicies/ObjectUUID ( Test GET of FlexConfig Policy )' : value: id: ObjectUUID links: self: https://u50c02p01-vrouter.cisco.com:45104/api/fmc_config/v1/domain/DomainUUID/policy/flexconfigpolicies/ObjectUUID metadata: domain: id: DomainUUID name: Global type: Domain name: flexconfig_test1 type: FlexConfigPolicy schema: $ref: '#/components/schemas/FlexConfig' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies: get: deprecated: false description: '**Get the list of all NAT policies.**' operationId: getAllFTDNatPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: schema: $ref: '#/components/schemas/FTDNatPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create a NAT policy. _Check the response section for applicable examples (if any)._**' operationId: createFTDNatPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies ( Example payloads for POST on NAT policy. )': value: description: nat policy for testing rest api name: NatPol5 type: FTDNatPolicy schema: $ref: '#/components/schemas/FTDNatPolicy' type: object description: Input representation of NAT policy. required: true responses: '201': content: application/json: examples: 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies ( Example payloads for POST on NAT policy. )': value: description: nat policy for testing rest api id: natPolUuid1 links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid1 name: NatPol5 rules: links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid1/natrules refType: list type: FTDNatPolicy schema: $ref: '#/components/schemas/FTDNatPolicy' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/autonatrules: delete: deprecated: false description: '**Delete all Auto NAT rules. Use filtering to specify which rules will be deleted. _Check the response section for applicable examples (if any)._**' operationId: deleteMultipleFTDAutoNatRule parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: true schema: type: boolean - description: 'Value is of format :

"ids:id1,id2,...;sourceInterface:name1,name2,...;destinationInterface:name1,name2,...;
originalSource:name1/value1,name2/value2,...;translatedSource:name1/value1,name2/value2,...;
originalSourcePort:name1/value1,name2/value2,...;translatedSourcePort:name1/value1,name2/value2,...;"

ids:id1,id2,...etc. This ids is a comma-separated list of rule ids to delete
sourceInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule
destinationInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to delete NAT rule
originalSource: Network object configured as Original source object name (object_name) or the value (10.1.2.3) of the object can be given
translatedSource:Network object configured as translated source object name (object_name) or the value (10.1.2.3) of the object can be given
originalSourcePort:Port object configured as Original Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given
translatedSourcePort:Port object configured as Translated Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given
' in: query name: filter required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid ( Example payload for DELETE request on Auto NAT rules with PAT options. )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: DYNAMIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid name: Network object name type: Network patOptions: extendedPat: true flatPortRange: true includeReserve: true interfacePat: false patPoolAddress: id: Host object uuid name: NW1 type: Host roundRobin: true routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone type: FTDAutoNatRule ? 'Example 2 : DELETE /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true&filter="originalSource:networkObj1;ids:autoNatRuleUuid1,autoNatRuleUuid2" ( Example payload for DELETE on Auto NAT rules with ?bulk=true and filter with originalSource and id )' : value: items: - destinationInterface: id: secZoneObjUuid1 name: seczonemanual1 type: SecurityZone dns: false id: autoNatRuleUuid1 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid1 metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid1 name: networkObj1 type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid2 name: seczonemanual2 type: SecurityZone translatedNetwork: id: networkObjUuid2 name: networkObj2 type: Network translatedPort: 1234 type: FTDAutoNatRule - destinationInterface: id: secZoneObjUuid1 name: seczonemanual1 type: SecurityZone dns: false id: autoNatRuleUuid2 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid2 metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid1 name: networkObj1 type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid2 name: seczonemanual2 type: SecurityZone translatedNetwork: id: networkObjUuid3 name: networkObj3 type: Network translatedPort: 1234 type: FTDAutoNatRule links: self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true&filter="originalSource:networkObj1;ids:autoNatRuleUuid1,autoNatRuleUuid2" ? 'Example 3 : DELETE /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true&filter="originalSource:originalSourceName1,originalSourceName2" ( Example payload for DELETE on Auto NAT rules with ?bulk=true and filter with originalSource )' : value: items: - destinationInterface: id: secZoneObjUuid1 name: seczonemanual1 type: SecurityZone dns: false id: autoNatRuleUuid1 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid2 name: originalSourceName1 type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid2 name: seczonemanual2 type: SecurityZone translatedNetwork: id: networkObjUuid1 name: translatedNetworkName1 type: Network translatedPort: 1234 type: FTDAutoNatRule - destinationInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone dns: false id: autoNatRuleUuid2 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid3 name: originalSourceName2 type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone translatedNetwork: id: networkObjUuid name: translatedNetworkName2 type: Network translatedPort: 1234 type: FTDAutoNatRule links: self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true&filter="originalSource:originalSourceName1,originalSourceName2" schema: $ref: '#/components/schemas/FTDAutoNatRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the list of all Auto NAT rules.**' operationId: getAllFTDAutoNatRule parameters: - description: 'Value is of format :

"ids:id1,id2,...;sourceInterface:name1,name2,...;destinationInterface:name1,name2,...;
originalSource:name1/value1,name2/value2,...;translatedSource:name1/value1,name2/value2,...;
originalSourcePort:name1/value1,name2/value2,...;translatedSourcePort:name1/value1,name2/value2,...;"

ids:id1,id2,...etc. This ids is a comma-separated list of rule ids to fetch
sourceInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch NAT rule
destinationInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule
originalSource: Network object configured as Original source object name (object_name) or the value (10.1.2.3) of the object can be given
translatedSource:Network object configured as translated source object name (object_name) or the value (10.1.2.3) of the object can be given
originalSourcePort:Port object configured as Original Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given
translatedSourcePort:Port object configured as Translated Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given
' in: query name: filter required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?expanded=true ( Example payload for GET ALL listing with ?expanded=true )' : value: items: - destinationInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone dns: false id: autoNatRuleUuid1 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid1 metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid name: IPv4-Link-Local type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone translatedNetwork: id: networkObjUuid name: IPv4-Multicast type: Network translatedPort: 1234 type: FTDAutoNatRule - destinationInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone dns: false id: autoNatRuleUuid2 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid2 metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489032251323.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid name: IPv4-Multicast type: Network type: FTDAutoNatRule links: self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules?offset=0&limit=2&expanded=true paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?filter="ids:autoNatRuleUuid1,autoNatRuleUuid2"&expanded=true ( Example payload for GET ALL listing with ?expanded=true and filter with ids )' : value: items: - destinationInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone dns: false id: autoNatRuleUuid1 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid1 metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid name: IPv4-Link-Local type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone translatedNetwork: id: networkObjUuid name: IPv4-Multicast type: Network translatedPort: 1234 type: FTDAutoNatRule - destinationInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone dns: false id: autoNatRuleUuid2 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid2 metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489032251323.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid name: IPv4-Multicast type: Network type: FTDAutoNatRule links: self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules?offset=0&limit=25&filter="ids:autoNatRuleUuid1,autoNatRuleUuid2"&expanded=true paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDAutoNatRuleListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create an Auto NAT rule. _Check the response section for applicable examples (if any)._**' operationId: createMultipleFTDAutoNatRule parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: false schema: type: boolean - description: Section in which to create the Auto NAT rule. Can be set to "auto". in: query name: section required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules ( Example payload for POST request on auto NAT rules. )' : value: destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid type: Network routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone translatedNetwork: id: Network object uuid type: Network type: FTDAutoNatRule ? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules ( Example payload for POST request on auto NAT rules with PAT block-allocation. )' : value: destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false interfaceIpv6: false natType: DYNAMIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid type: Network patOptions: blockAllocation: true extendedPat: false flatPortRange: false includeReserve: false interfacePat: false patPoolAddress: id: Host object uuid name: NW1 type: Host roundRobin: true routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone type: FTDAutoNatRule ? 'Example 3 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules ( Example payload for POST request on auto NAT rules with interface in translated network )' : value: destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false interfaceInTranslatedNetwork: true interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid type: Network routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone type: FTDAutoNatRule ? 'Example 4 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true ( Example payload for bulk POST on auto NAT rules )' : value: - destinationInterface: id: sec_zone_id name: sec_zone_name type: SecurityZone dns: false fallThrough: false interfaceInTranslatedNetwork: false interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: net_obj_id name: net_obj_name type: Network originalPort: 123 routeLookup: false serviceProtocol: TCP sourceInterface: id: sec_zone_id name: sec_zone_name type: SecurityZone translatedNetwork: id: net_obj_id name: net_obj_name type: Network translatedPort: 234 type: FTDAutoNatRule - destinationInterface: id: sec_zone_id name: sec_zone_name type: SecurityZone dns: false fallThrough: false interfaceInTranslatedNetwork: false interfaceIpv6: false natType: DYNAMIC netToNet: false noProxyArp: false originalNetwork: id: net_obj_id name: net_obj_name type: Network originalPort: 0 patOptions: extendedPat: false flatPortRange: true includeReserve: false interfacePat: false patPoolAddress: id: net_obj_id name: net_obj_name type: Network roundRobin: false routeLookup: false sourceInterface: id: sec_zone_id name: sec_zone_name type: SecurityZone translatedPort: 0 type: FTDAutoNatRule schema: $ref: '#/components/schemas/FTDAutoNatRule' type: object description: The input Auto NAT rule model. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules ( Example payload for POST request on auto NAT rules. )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid name: Network object name type: Network routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone translatedNetwork: id: Network object uuid name: Network object name type: Network type: FTDAutoNatRule ? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules ( Example payload for POST request on auto NAT rules with PAT block-allocation. )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: DYNAMIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid name: Network object name type: Network patOptions: blockAllocation: true extendedPat: false flatPortRange: false includeReserve: false interfacePat: false patPoolAddress: id: Host object uuid name: NW1 type: Host roundRobin: true routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone type: FTDAutoNatRule ? 'Example 3 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules ( Example payload for POST request on auto NAT rules with interface in translated network )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceInTranslatedNetwork: true interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid name: Network object name type: Network routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone type: FTDAutoNatRule schema: $ref: '#/components/schemas/FTDAutoNatRule' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify multiple Auto NAT rules. _Check the response section for applicable examples (if any)._**' operationId: updateMultipleFTDAutoNatRule parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: false schema: type: boolean - description: Boolean indicating whether to change the entire object or only certain attributes of it. The default value is FALSE. in: query name: partialUpdate required: false schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid ( Example payload for PUT request on Auto NAT rules )' : value: destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid type: Network routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone translatedNetwork: id: Network object uuid type: Network type: FTDAutoNatRule ? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid ( Example payload for PUT request on Auto NAT rules with PAT options. )' : value: destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false natType: DYNAMIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid type: Network patOptions: extendedPat: true flatPortRange: true includeReserve: true interfacePat: false patPoolAddress: id: Host object uuid name: NW1 type: Host roundRobin: true routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone type: FTDAutoNatRule ? 'Example 3 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true ( Example payload for BULK PUT request on Auto NAT rules with bulk=true )' : value: - destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid1 interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid1 type: Network routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone translatedNetwork: id: Network object uuid type: Network type: FTDAutoNatRule - destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid2 interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid2 type: Network routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone translatedNetwork: id: Network object uuid type: Network type: FTDAutoNatRule ? 'Example 4 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=false ( Example payload for BULK PUT request on Auto NAT rules with bulk=false )' : value: destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid1 interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid1 type: Network routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone translatedNetwork: id: Network object uuid type: Network type: FTDAutoNatRule schema: $ref: '#/components/schemas/FTDAutoNatRule' type: object description: The input Auto NAT rule model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid ( Example payload for PUT request on Auto NAT rules )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid name: Network object name type: Network routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone translatedNetwork: id: Network object uuid name: Network object name type: Network type: FTDAutoNatRule ? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid ( Example payload for PUT request on Auto NAT rules with PAT options. )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: DYNAMIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid name: Network object name type: Network patOptions: extendedPat: true flatPortRange: true includeReserve: true interfacePat: false patPoolAddress: id: Host object uuid name: NW1 type: Host roundRobin: true routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone type: FTDAutoNatRule ? 'Example 3 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true ( Example payload for BULK PUT request on Auto NAT rules with bulk=true )' : value: - destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid1 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid1 name: Network object name type: Network routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone translatedNetwork: id: Network object uuid name: Network object name type: Network type: FTDAutoNatRule - destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid2 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid2 name: Network object name type: Network routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone translatedNetwork: id: Network object uuid name: Network object name type: Network type: FTDAutoNatRule ? 'Example 4 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=false ( Example payload for BULK PUT request on Auto NAT rules with bulk=false )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid1 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid1 name: Network object name type: Network routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone translatedNetwork: id: Network object uuid name: Network object name type: Network type: FTDAutoNatRule schema: $ref: '#/components/schemas/FTDAutoNatRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/autonatrules/{objectId}: delete: deprecated: false description: '**Delete the Auto NAT rule associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteFTDAutoNatRule parameters: - description: Unique identifier of the Auto NAT rule. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid ( Example payload for DELETE request on Auto NAT rules with PAT options. )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: DYNAMIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid name: Network object name type: Network patOptions: extendedPat: true flatPortRange: true includeReserve: true interfacePat: false patPoolAddress: id: Host object uuid name: NW1 type: Host roundRobin: true routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone type: FTDAutoNatRule ? 'Example 2 : DELETE /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true&filter="originalSource:networkObj1;ids:autoNatRuleUuid1,autoNatRuleUuid2" ( Example payload for DELETE on Auto NAT rules with ?bulk=true and filter with originalSource and id )' : value: items: - destinationInterface: id: secZoneObjUuid1 name: seczonemanual1 type: SecurityZone dns: false id: autoNatRuleUuid1 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid1 metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid1 name: networkObj1 type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid2 name: seczonemanual2 type: SecurityZone translatedNetwork: id: networkObjUuid2 name: networkObj2 type: Network translatedPort: 1234 type: FTDAutoNatRule - destinationInterface: id: secZoneObjUuid1 name: seczonemanual1 type: SecurityZone dns: false id: autoNatRuleUuid2 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid2 metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid1 name: networkObj1 type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid2 name: seczonemanual2 type: SecurityZone translatedNetwork: id: networkObjUuid3 name: networkObj3 type: Network translatedPort: 1234 type: FTDAutoNatRule links: self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true&filter="originalSource:networkObj1;ids:autoNatRuleUuid1,autoNatRuleUuid2" ? 'Example 3 : DELETE /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true&filter="originalSource:originalSourceName1,originalSourceName2" ( Example payload for DELETE on Auto NAT rules with ?bulk=true and filter with originalSource )' : value: items: - destinationInterface: id: secZoneObjUuid1 name: seczonemanual1 type: SecurityZone dns: false id: autoNatRuleUuid1 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid2 name: originalSourceName1 type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid2 name: seczonemanual2 type: SecurityZone translatedNetwork: id: networkObjUuid1 name: translatedNetworkName1 type: Network translatedPort: 1234 type: FTDAutoNatRule - destinationInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone dns: false id: autoNatRuleUuid2 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid3 name: originalSourceName2 type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone translatedNetwork: id: networkObjUuid name: translatedNetworkName2 type: Network translatedPort: 1234 type: FTDAutoNatRule links: self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true&filter="originalSource:originalSourceName1,originalSourceName2" schema: $ref: '#/components/schemas/FTDAutoNatRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the Auto NAT rule associated with the specified ID.**' operationId: getFTDAutoNatRule parameters: - description: Unique identifier of the Auto NAT rule. in: path name: objectId required: true schema: type: string - description: Section from which to get the Auto NAT rule. Can be set to "auto". in: query name: section required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid1 ( Example payload for GET request on auto NAT rules. )' : value: destinationInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone dns: false id: autoNatRuleUuid interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: domainUuid name: Global type: Domain section: AUTO timestamp: 1489053023583.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: networkObjUuid name: IPv4-Link-Local type: Network originalPort: 345 serviceProtocol: TCP sourceInterface: id: secZoneObjUuid name: seczonemanual type: SecurityZone translatedNetwork: id: networkObjUuid name: IPv4-Multicast type: Network translatedPort: 1234 type: FTDAutoNatRule ? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules ( Example payload for GET listing on auto NAT rules )' : value: items: - id: autoNatRuleUuid1 links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid1 type: FTDAutoNatRule - id: autoNatRuleUuid2 links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid2 type: FTDAutoNatRule links: self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules?offset=0&limit=6 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDAutoNatRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the Auto NAT rule associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateFTDAutoNatRule parameters: - description: Unique identifier of the Auto NAT rule. in: path name: objectId required: true schema: type: string - description: Boolean indicating whether to change the entire object or only certain attributes of it. The default value is FALSE. in: query name: partialUpdate required: false schema: type: boolean - description: Section of the Auto NAT rule. Can be set to "auto". in: query name: section required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid ( Example payload for PUT request on Auto NAT rules )' : value: destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid type: Network routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone translatedNetwork: id: Network object uuid type: Network type: FTDAutoNatRule ? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid ( Example payload for PUT request on Auto NAT rules with PAT options. )' : value: destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false natType: DYNAMIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid type: Network patOptions: extendedPat: true flatPortRange: true includeReserve: true interfacePat: false patPoolAddress: id: Host object uuid name: NW1 type: Host roundRobin: true routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone type: FTDAutoNatRule ? 'Example 3 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true ( Example payload for BULK PUT request on Auto NAT rules with bulk=true )' : value: - destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid1 interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid1 type: Network routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone translatedNetwork: id: Network object uuid type: Network type: FTDAutoNatRule - destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid2 interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid2 type: Network routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone translatedNetwork: id: Network object uuid type: Network type: FTDAutoNatRule ? 'Example 4 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=false ( Example payload for BULK PUT request on Auto NAT rules with bulk=false )' : value: destinationInterface: id: security zone uuid type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid1 interfaceIpv6: false natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid1 type: Network routeLookup: false sourceInterface: id: security zone uuid type: SecurityZone translatedNetwork: id: Network object uuid type: Network type: FTDAutoNatRule schema: $ref: '#/components/schemas/FTDAutoNatRule' type: object description: The input Auto NAT rule model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid ( Example payload for PUT request on Auto NAT rules )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid name: Network object name type: Network routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone translatedNetwork: id: Network object uuid name: Network object name type: Network type: FTDAutoNatRule ? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid ( Example payload for PUT request on Auto NAT rules with PAT options. )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: DYNAMIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid name: Network object name type: Network patOptions: extendedPat: true flatPortRange: true includeReserve: true interfacePat: false patPoolAddress: id: Host object uuid name: NW1 type: Host roundRobin: true routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone type: FTDAutoNatRule ? 'Example 3 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=true ( Example payload for BULK PUT request on Auto NAT rules with bulk=true )' : value: - destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid1 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid1 name: Network object name type: Network routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone translatedNetwork: id: Network object uuid name: Network object name type: Network type: FTDAutoNatRule - destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid2 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid2 name: Network object name type: Network routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone translatedNetwork: id: Network object uuid name: Network object name type: Network type: FTDAutoNatRule ? 'Example 4 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/autonatrules?bulk=false ( Example payload for BULK PUT request on Auto NAT rules with bulk=false )' : value: destinationInterface: id: security zone uuid name: Security zone object name type: SecurityZone dns: false fallThrough: false id: autoNatRuleUuid1 interfaceIpv6: false links: parent: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/global_domain_uuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid metadata: domain: id: global_domain_uuid name: Global type: Domain section: AUTO timestamp: 1493371106718.0 natType: STATIC netToNet: false noProxyArp: false originalNetwork: id: Network object uuid1 name: Network object name type: Network routeLookup: false sourceInterface: id: security zone uuid name: Security zone object name type: SecurityZone translatedNetwork: id: Network object uuid name: Network object name type: Network type: FTDAutoNatRule schema: $ref: '#/components/schemas/FTDAutoNatRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{containerUUID}/manualnatrules: delete: deprecated: false description: '**Delete all manual NAT rules. Use filtering to specify which rules will be deleted. _Check the response section for applicable examples (if any)._**' operationId: deleteMultipleFTDManualNatRule parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: true schema: type: boolean - description: 'Value is of format :

"ids:id1,id2,...;sourceInterface:name1,name2,...;destinationInterface:name1,name2,...;
originalSource:name1/value1,name2/value2,...;originalDestination:name1/value1,name2/value2,...;
translatedSource:name1/value1,name2/value2,...;translatedDestination:name1/value1,name2/value2,...;
originalSourcePort:name1/value1,name2/value2,...;originalDestinationPort:name1/value1,name2/value2,...;
translatedSourcePort:name1/value1,name2/value2,...;translatedDestinationPort:name1/value1,name2/value2,...;"

"ids:id1,id2,...;sourceInterface:name1,name2,...;destinationInterface:name1,name2,...;
originalSource:name1/value1,name2/value2,...;originalDestination:name1/value1,name2/value2,...;
translatedSource:name1/value1,name2/value2,...;translatedDestination:name1/value1,name2/value2,...;
originalSourcePort:name1/value1,name2/value2,...;originalDestinationPort:name1/value1,name2/value2,...;
translatedSourcePort:name1/value1,name2/value2,...;translatedDestinationPort:name1/value1,name2/value2,...;"

"ids:id1,id2,...;sourceInterface:name1,name2,...;destinationInterface:name1,name2,...;
originalSource:name1/value1,name2/value2,...;originalDestination:name1/value1,name2/value2,...;
translatedSource:name1/value1,name2/value2,...;translatedDestination:name1/value1,name2/value2,...;
originalSourcePort:name1/value1,name2/value2,...;originalDestinationPort:name1/value1,name2/value2,...;
translatedSourcePort:name1/value1,name2/value2,...;translatedDestinationPort:name1/value1,name2/value2,...;"

"ids:id1,id2,...;sourceInterface:name1,name2,...;destinationInterface:name1,name2,...;
originalSource:name1/value1,name2/value2,...;originalDestination:name1/value1,name2/value2,...;
translatedSource:name1/value1,name2/value2,...;translatedDestination:name1/value1,name2/value2,...;
originalSourcePort:name1/value1,name2/value2,...;originalDestinationPort:name1/value1,name2/value2,...;
translatedSourcePort:name1/value1,name2/value2,...;translatedDestinationPort:name1/value1,name2/value2,...;"

"ids:id1,id2,...;sourceInterface:name1,name2,...;destinationInterface:name1,name2,...;
originalSource:name1/value1,name2/value2,...;originalDestination:name1/value1,name2/value2,...;
translatedSource:name1/value1,name2/value2,...;translatedDestination:name1/value1,name2/value2,...;
originalSourcePort:name1/value1,name2/value2,...;originalDestinationPort:name1/value1,name2/value2,...;
translatedSourcePort:name1/value1,name2/value2,...;translatedDestinationPort:name1/value1,name2/value2,...;"

ids:id1,id2,...etc. This ids is a comma-separated list of rule ids to fetch/delete
sourceInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule
destinationInterface:SecurityZone/Interface group name (sec_zone_name1) can be given as value to fetch/delete NAT rule
originalSource: Network object configured as Original source object name (object_name) or the value (10.1.2.3) of the object can be given
originalDestination:Network object configured as Destination source object name (object_name) or the value (10.1.2.3) of the object can be given
translatedSource:Network object configured as translated source object name (object_name) or the value (10.1.2.3) of the object can be given
translatedDestination:Network object configured as translated Destination object name (object_name) or the value (10.1.2.3) of the object can be given
originalSourcePort:Port object configured as Original Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given
originalDestinationPort:Port object configured as Original Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given
translatedSourcePort:Port object configured as Translated Source Port object name (http) or value of the object as port no or protocol (tcp/80) can be given
translatedDestinationPort:Port object configured as Translated Destination Port object name (http) or value of the object as port no or protocol (tcp/80) can be given"
' in: query name: filter required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid/natrules ( Example payload for GET on NAT rules )' : value: items: - id: manualNatRuleUuid links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/manualnatrules/manualNatRuleUuid type: FTDManualNatRule - id: autoNatRuleUuid links: parent: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/autonatrules/autoNatRuleUuid type: FTDAutoNatRule links: self: /api/fmc_config/v1/domain/domainUuid/policy/ftdnatpolicies/natPolicyUuid/natrules?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDNatRule' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdnatpolicies/{objectId}: delete: deprecated: false description: '**Delete the NAT policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteFTDNatPolicy parameters: - description: Unique identifier of the NAT policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolicyUuid ( Example payload for DELETE on NAT policy. )' : value: description: Updated description id: natPolicyUuid links: self: /api/fmc_config/v1/domain/domainUUID/policy/natpolicies/natPolicyUuid name: UpdatedNatPolName rules: links: self: /api/fmc_config/v1/domain/domainUUID/policy/natpolicies/natPolicyUuid/natrules refType: list type: FTDNatPolicy schema: $ref: '#/components/schemas/FTDNatPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the NAT policy associated with the specified ID.**' operationId: getFTDNatPolicy parameters: - description: Unique identifier of the NAT policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies/natPolicyUuid ( Example payloads for GET on NAT policy. )' : value: description: nat policy for testing id: natPolUuid1 links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid1 name: NatPol rules: links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid1/natrules refType: list type: FTDNatPolicy ? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies ( Example payloads for GET listing on NAT policy. )' : value: items: - id: natPolUuid1 links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid1 name: NatPol type: FTDNatPolicy - id: natPolUuid2 links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid2 name: NatPol2 type: FTDNatPolicy links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 3 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdnatpolicies?expanded=true ( Example payload for GET on NAT policy with expanded=true )' : value: items: - description: nat policy 1 for testing id: natPolUuid1 links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid1 name: NatPol rules: links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid1/natrules refType: list type: FTDNatPolicy - description: Some description id: natPolUuid2 links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid2 name: NatPol2 rules: links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies/natPolUuid2/natrules refType: list type: FTDNatPolicy links: self: /api/fmc_config/v1/domain/domainUUID/policy/ftdnatpolicies?offset=0&limit=2&expanded=true paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDNatPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the NAT policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateFTDNatPolicy parameters: - description: Unique identifier of the NAT policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/FTDNatPolicy' type: object description: Input representation of NAT policy. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FTDNatPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies: get: deprecated: false description: '**Get the list of all FTD platform settings policies.**' operationId: getAllFTDPlatformSettingsPolicy parameters: - description: Filter criteria can be specified using the format name:policy_name

policy_name -- Name of the FTDPlatformSettings Policy to be queried. in: query name: filter required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies ( Test GET ALL of FTDPlatformSettings Policy )' : value: items: - id: ObjectUUID links: self: https://example.cisco.com/api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/ObjectUUID name: platform_settings_test1 type: FTDPlatformSettingsPolicy - id: ObjectUUID links: self: https://example.cisco.com/api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/ObjectUUID name: platform_settings_test2 type: FTDPlatformSettingsPolicy links: self: https://example.cisco.com/api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies?offset=0&limit=25 paging: count: 2 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDPlatformSettingsPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create an FTD platform settings policy. _Check the response section for applicable examples (if any)._**' operationId: createFTDPlatformSettingsPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies ( Test POST FTDPlatformSettings Policy )' : value: description: Description of FTDPlatformSettingsPolicy1 name: FTDPlatformSettingsPolicy1 type: FTDPlatformSettingsPolicy schema: $ref: '#/components/schemas/FTDPlatformSettingsPolicy' type: object description: The input for FTDPlatformSettings Policy. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies ( Test POST FTDPlatformSettings Policy )' : value: description: Description of FTDPlatformSettingsPolicy1 id: ObjectUUID links: self: https://example.cisco.com/api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies metadata: domain: id: DomainUUID name: Global type: Domain name: FTDPlatformSettingsPolicy1 type: FTDPlatformSettingsPolicy schema: $ref: '#/components/schemas/FTDPlatformSettingsPolicy' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/bannersettings: get: deprecated: false description: '**Get all login banner policies for the given platform settings.**' operationId: getAllLoginBannerSettingsPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/bannersettings ( Example payload for GET ALL on FTD LOGIN BANNER Settings )' : value: items: - bannerText: - You are - Logged into - Secure - Device id: policy_uuid links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//bannersettings/ type: BannerSetting links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/bannersettings paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/LoginBannerSettingsPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/bannersettings/{objectId} : get: deprecated: false description: '**Get the login banner policy associated with the specified ID.**' operationId: getLoginBannerSettingsPolicy parameters: - description: Unique identifier of the container Threat Defense Platform Settings policy to which this Login banner policy belongs. Same as container UUID. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: schema: $ref: '#/components/schemas/LoginBannerSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the login banner policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateLoginBannerSettingsPolicy parameters: - description: Unique identifier of the container Threat Defense Platform Settings policy to which this Login banner policy belongs. Same as container UUID. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//bannersettings/ ( Example payload for PUT on FTD LOGIN BANNER Setting. )' : value: bannerText: - You are now - Logged into - Secure Device id: 00505681-4717-0ed3-0000-021474836844 type: BannerSetting schema: $ref: '#/components/schemas/LoginBannerSettingsPolicy' type: object description: Input representation of login banner setting model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//bannersettings/ ( Example payload for PUT on FTD LOGIN BANNER Setting. )' : value: bannerText: - You are now - Logged into - Secure Device id: 00505681-4717-0ed3-0000-021474836844 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//bannersettings/ type: BannerSetting schema: $ref: '#/components/schemas/LoginBannerSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/dnssettings: get: deprecated: false description: '**Retrieves all DNS-Settings policies for a particular FTD .**' operationId: getAllFTDDNSSettingsPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/dnssettings?offset=0&limit=25 ( Example payload for GET ALL on FTD DNS Settings )' : value: items: - id: policy_uuid links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//dnssettings/ type: DNSSetting links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/dnssettings?offset=0&limit=25 paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies//dnssettings?offset=0&limit=2&expanded=true ( GET All FTD DNS Settings with expanded=true )' : value: items: - dnsServerGroups: - bypassDomains: - cisco.com - google.com dnsServerGroup: id: 00505681-5423-0ed3-0000-012884902039 name: DNS-2 type: DNSServerGroupObject isDefault: false - dnsServerGroup: id: 00505681-5423-0ed3-0000-012884902021 name: DNS-1 type: DNSServerGroupObject isDefault: true enableLookupViaMgmt: true expiryTimerInMins: 500 id: policy_uuid interfaceObjects: - id: 0b328828-ed89-11ee-ab99-a04b357bbab6 name: SZ type: SecurityZone - id: 643b40f4-ed89-11ee-b736-bdededcfc353 name: SZ-1 type: SecurityZone links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies//dnssettings?offset=0&limit=2&expanded=true pollTimerInMins: 501 type: DNSSetting links: url: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies//dnssettings?offset=0&limit=2&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDDNSSettingsPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/dnssettings/{objectId}: get: deprecated: false description: '**Retrieves the Threat Defense DNS-Settings Platform settings policy.**' operationId: getFTDDNSSettingsPolicy parameters: - description: The identifier of the container Threat Defense Platform Settings policy to which this DNS-Settings singleton policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//dnssettings/ ( Example payload for GET on DNS Settings )' : value: dnsServerGroups: - bypassDomains: - cisco.com - abc.com dnsServerGroup: id: 00505681-5423-0ed3-0000-012884902039 name: DNS-2 type: DNSServerGroupObject isDefault: false - bypassDomains: any dnsServerGroup: id: 00505681-5423-0ed3-0000-012884902021 name: DNS-1 type: DNSServerGroupObject isDefault: true id: 00505681-5423-0ed3-0000-012884901993 interfaceObjects: - id: 0b328828-ed89-11ee-ab99-a04b357bbab6 name: SZ type: SecurityZone - id: 643b40f4-ed89-11ee-b736-bdededcfc353 name: SZ-1 type: SecurityZone links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//dnssettings/ type: DNSSetting schema: $ref: '#/components/schemas/FTDDNSSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modifies the Threat Defense DNS-Settings Platform settings policy. _Check the response section for applicable examples (if any)._**' operationId: updateFTDDNSSettingsPolicy parameters: - description: The identifier of the container Threat Defense Platform Settings policy to which this DNS-Settings singleton policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//dnssettings/ ( Example payload for PUT on FTD DNS Settings. )' : value: dnsServerGroups: - bypassDomains: - cisco.com - abc.com dnsServerGroup: id: 00505681-5423-0ed3-0000-012884902039 name: DNS-2 type: DNSServerGroupObject isDefault: false - dnsServerGroup: id: 00505681-5423-0ed3-0000-012884902021 name: DNS-1 type: DNSServerGroupObject isDefault: true enableLookupViaMgmt: true expiryTimerInMins: 500 id: 00505681-5423-0ed3-0000-025769803885 interfaceObjects: - id: 0b328828-ed89-11ee-ab99-a04b357bbab6 name: SZ type: SecurityZone - id: 643b40f4-ed89-11ee-b736-bdededcfc353 name: SZ-1 type: SecurityZone pollTimerInMins: 501 type: DNSSetting schema: $ref: '#/components/schemas/FTDDNSSettingsPolicy' type: object description: Input representation of DNS-Settings policy object. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//dnssettings/ ( Example payload for PUT on FTD DNS Settings. )' : value: dnsServerGroups: - bypassDomains: - cisco.com - abc.com dnsServerGroup: id: 00505681-5423-0ed3-0000-012884902039 name: DNS-2 type: DNSServerGroupObject isDefault: false - dnsServerGroup: id: 00505681-5423-0ed3-0000-012884902021 name: DNS-1 type: DNSServerGroupObject isDefault: true enableLookupViaMgmt: true expiryTimerInMins: 500 id: 00505681-5423-0ed3-0000-025769803885 interfaceObjects: - id: 0b328828-ed89-11ee-ab99-a04b357bbab6 name: SZ type: SecurityZone - id: 643b40f4-ed89-11ee-b736-bdededcfc353 name: SZ-1 type: SecurityZone links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//dnssettings/ pollTimerInMins: 501 type: DNSSetting schema: $ref: '#/components/schemas/FTDDNSSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/httpaccesssettings: get: deprecated: false description: '**Get all Threat Defense HTTP access settings.**' operationId: getAllFTDHttpAccessSettingsPolicy parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/httpaccesssettings?offset=0&limit=25 ( Example payload for GET ALL on FTD HTTP Settings )' : value: items: - enableHttpServer: true id: policy_uuid links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//httpaccesssettings/ port: 444 type: HTTPAccessSetting links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/httpaccesssettings?offset=0&limit=25 paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies//httpaccesssettings?offset=0&limit=2&expanded=true ( GET All FTD HTTP Settings with expanded=true )' : value: items: - enableHttpServer: true httpConfiguration: - interfaces: literals: - intfc1 objects: - id: 16c9e612-3b70-11ed-9272-c2faee768898 name: zone1 type: SecurityZone ipAddress: object: id: 5622db1c-5cd5-4199-a4c8-d8f86dec3bd4 name: IPv4-Multicast type: Network - interfaces: literals: - intfc2 ipAddress: literal: type: Network value: 10.10.1.11 id: 00000000-0000-0ed3-0000-004294969356 port: 444 type: HTTPAccessSetting links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies//httpaccesssettings?offset=0&limit=2&expanded=true paging: count: 1 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDHttpAccessSettingsPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/httpaccesssettings/{objectId} : get: deprecated: false description: '**Get the Threat Defense HTTP access settings policy associated with the specified ID.**' operationId: getFTDHttpAccessSettingsPolicy parameters: - description: Unique identifier of the Threat Defense Platform Settings Policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: schema: $ref: '#/components/schemas/FTDHttpAccessSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the Threat Defense HTTP access settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateFTDHttpAccessSettingsPolicy parameters: - description: Unique identifier of the Threat Defense Platform Settings Policy. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//httpaccesssettings/ ( Example payload for PUT on HTTP Access. )' : value: enableHttpServer: true httpConfiguration: - interfaces: literals: - interfacg objects: - id: 16c9e612-3b70-11ed-9272-c2faee768898 name: s1 type: SecurityZone - id: 21666ab4-3b70-11ed-b180-d3245bb972ab name: s2 type: SecurityZone ipAddress: id: fb7116e8-66a6-480b-8f9b-295191a0940a name: 11.12.123.14 type: NETWORK - interfaces: literals: - nltners ipAddress: id: av1236e8-66a6-480b-8f9b-905191a06780 name: 13.12.123.14 type: NETWORK id: 00000000-0000-0ed3-0000-004294969356 port: 1203 schema: $ref: '#/components/schemas/FTDHttpAccessSettingsPolicy' type: object description: Input representation of Threat Defense HTTP access settings policy. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//httpaccesssettings/ ( Example payload for PUT on HTTP Access. )' : value: enableHttpServer: true httpConfiguration: - interfaces: - literals: - intfcg objects: - id: 16c9e612-3b70-11ed-9272-c2faee768898 name: s1 type: SecurityZone - id: 21666ab4-3b70-11ed-b180-d3245bb972ab name: s2 type: SecurityZone ipAddress: id: fb7116e8-66a6-480b-8f9b-295191a0940a name: 11.12.123.14 type: NETWORK - interfaces: - literals: - nltners ipAddress: id: av1236e8-66a6-480b-8f9b-905191a06780 name: 13.12.123.14 type: NETWORK id: 00000000-0000-0ed3-0000-004294969356 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//httpaccesssettings/ port: 1203 schema: $ref: '#/components/schemas/FTDHttpAccessSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/icmpsettings: get: deprecated: false description: '**Get all ICMP access policies.**' operationId: getAllIcmpAccessSettingsPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: schema: $ref: '#/components/schemas/IcmpAccessSettingsPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/icmpsettings/{objectId}: get: deprecated: false description: '**Get the ICMP access policy associated with the specified ID.**' operationId: getIcmpAccessSettingsPolicy parameters: - description: The identifier of the settings policy to which the ICMP access policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/ftdplatformsettingspolicies/containerUUID/icmpsettings ( Example payload for GET on FTD ICMP Access PlatformSettings )' : value: items: - burstSize: '7' icmpConfigs: - icmpAction: Permit icmpService: id: 00505681-4717-0ed3-0000-008589934644 name: icmpPort type: ICMPV4Object interfaces: literals: - inside - outside objects: - id: 89b89ab4-f88f-11ee-b93a-ba75fedfc0a1 name: securityZoneRouted type: SecurityZone network: object: id: 69fa2a3a-4487-4e3c-816f-4098f684826e name: any type: Network - icmpAction: Permit icmpService: id: 00505681-4717-0ed3-0000-008589934644 name: icmpPort type: ICMPV4Object interfaces: literals: - inside objects: - id: 89b89ab4-f88f-11ee-b93a-ba75fedfc0a1 name: securityZoneRouted type: SecurityZone - id: d7b9e8c8-7715-11ed-8c1c-b2953a72825d name: INTGRP1 type: InterfaceGroup network: literal: 192.168.1.1 id: policy_uuid links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/policy/ftdplatformsettingspolicies/containerUUID/icmpsettings/objectId rateLimit: '10' type: ICMPSetting links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/policy/ftdplatformsettingspolicies/containerUUID/icmpsettings?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/IcmpAccessSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the ICMP access policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateIcmpAccessSettingsPolicy parameters: - description: The identifier of the settings policy to which the ICMP access policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/ftdplatformsettingspolicies/containerUUID/icmpsettings/objectId ( PUT request to update ICMP Access Platform Settings )' : value: burstSize: '5' icmpConfigs: - icmpAction: Permit icmpService: id: 00505681-333C-0ed3-0000-188978561076 name: icmpv6Port type: ICMPV6Object interfaces: literals: - inside objects: - id: 89b89ab4-f88f-11ee-b93a-ba75fedfc0a1 name: securityZoneRouted type: SecurityZone network: literal: 192.168.1.2 id: 00505681-4717-0ed3-0000-021474836844 rateLimit: '15' type: ICMPSetting schema: $ref: '#/components/schemas/IcmpAccessSettingsPolicy' type: object description: Input representing icmp access setting policy model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/ftdplatformsettingspolicies/containerUUID/icmpsettings/objectId ( PUT request to update ICMP Access Platform Settings )' : value: burstSize: '5' icmpConfigs: - icmpAction: Permit icmpService: id: 00505681-333C-0ed3-0000-188978561076 name: icmpv6Port type: ICMPV6Object interfaces: literals: - outside objects: - id: 89b89ab4-f88f-11ee-b93a-ba75fedfc0a1 name: securityZoneRouted type: SecurityZone network: literal: 192.168.1.2 id: 00505681-4717-0ed3-0000-021474836844 links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/policy/ftdplatformsettingspolicies/containerUUID/icmpsettings/objectId rateLimit: '15' type: ICMPSetting schema: $ref: '#/components/schemas/IcmpAccessSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/netflowpolicies: get: deprecated: false description: '**Get the list of all NetFlow policies.**' operationId: getAllNetFlowPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/netflowpolicies ( GET ALL NetFlow Policies )' : value: items: - delayFlowCreate: 12 enable: true flowCollectors: - collectorHost: id: e276abeb-e0f2-11e3-8169-6d9ed49b625f name: hostIP type: Network interfaces: objects: - id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: LOOPBACK_TYPE_IG type: InterfaceGroup port: '4567' id: NetFlowPolicyUUID refreshInterval: 25 templateExportTime: 30 trafficClasses: - exportFlows: - collectorHost: id: e276abeb-e0f2-11e3-8169-6d9ed49b625f name: hostIP type: Network eventType: - ALL extendedAccessList: id: d5eefa54-5449-11ed-bce6-c70590de7487 name: test_access_list type: ExtendedAccessList trafficClassName: traffic_class_1 trafficClassType: ACCESS_LIST type: NetFlowPolicy links: self: https://u32c01p06-vrouter:22552/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/containerUUID/netflowpolicies?offset=0&limit=25 paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/NetFlowPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/netflowpolicies/{objectId} : get: deprecated: false description: '**Get the NetFlow policy associated with the specified ID.**' operationId: getNetFlowPolicy parameters: - description: The identifier of the settings policy to which the NetFlow policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/netflowpolicies/ObjectUUID ( GET NetFlowPolicy by object ID )' : value: delayFlowCreate: 12 enable: true flowCollectors: - collectorHost: id: e276abeb-e0f2-11e3-8169-6d9ed49b625f name: hostIP type: Network interfaces: objects: - id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: ROUTED_TYPE_INSIDE_IG type: InterfaceGroup port: '4566' id: NetFlowPolicyUUID refreshInterval: 25 templateExportTime: 30 trafficClasses: - exportFlows: - collectorHost: id: e276abeb-e0f2-11e3-8169-6d9ed49b625f name: hostIP type: Network eventType: - ALL extendedAccessList: id: d5eefa54-5449-11ed-bce6-c70590de7487 name: test_access_list type: ExtendedAccessList trafficClassName: traffic_class_1 trafficClassType: ACCESS_LIST type: NetFlowPolicy schema: $ref: '#/components/schemas/NetFlowPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the NetFlow policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateNetFlowPolicy parameters: - description: The identifier of the settings policy to which the NetFlow policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/netflowpolicies ( PUT request to update a NetFlow Policy )' : value: delayFlowCreate: 12 enable: true flowCollectors: - collectorHost: id: e276abeb-e0f2-11e3-8169-6d9ed49b625f name: hostIP type: Network interfaces: objects: - id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: MGMT_TYPE_IG type: InterfaceGroup port: '4566' id: NetFlowPolicyUUID refreshInterval: 25 templateExportTime: 30 trafficClasses: - exportFlows: - collectorHost: id: e276abeb-e0f2-11e3-8169-6d9ed49b625f name: hostIP type: Network eventType: - ALL extendedAccessList: id: d5eefa54-5449-11ed-bce6-c70590de7487 name: test_access_list type: ExtendedAccessList trafficClassName: traffic_class_1 trafficClassType: ACCESS_LIST type: NetFlowPolicy schema: $ref: '#/components/schemas/NetFlowPolicy' type: object description: Input representing NetFlow setting policy model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/netflowpolicies ( PUT request to update a NetFlow Policy )' : value: delayFlowCreate: 12 enable: true flowCollectors: - collectorHost: id: e276abeb-e0f2-11e3-8169-6d9ed49b625f name: hostIP type: Network interfaces: objects: - id: e276abec-e0f2-11e3-8169-6d9ed49b625f name: MGMT_TYPE_IG type: InterfaceGroup port: '4566' id: NetFlowPolicyUUID refreshInterval: 25 templateExportTime: 30 trafficClasses: - exportFlows: - collectorHost: id: e276abeb-e0f2-11e3-8169-6d9ed49b625f name: hostIP type: Network eventType: - ALL extendedAccessList: id: d5eefa54-5449-11ed-bce6-c70590de7487 name: test_access_list type: ExtendedAccessList trafficClassName: traffic_class_1 trafficClassType: ACCESS_LIST type: NetFlowPolicy schema: $ref: '#/components/schemas/NetFlowPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/ntpsettings: get: deprecated: false description: '**Get the list of all NTP settings.**' operationId: getAllNTPSettingsPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/ntpsettings?offset=0&limit=25&expanded=true ( Example payload for GET ALL on FTD NTP Settings with SYNC_VIA_MGMT_CENTER_NTP )' : value: items: - id: links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//ntpsettings/ ntpMode: SYNC_VIA_MGMT_CENTER_NTP type: NTPSetting links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/ntpsettings?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/ntpsettings?offset=0&limit=25&expanded=true ( Example payload for GET ALL on FTD NTP Settings with SYNC_VIA_NTP_SERVER )' : value: items: - id: links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//ntpsettings/ ntpMode: SYNC_VIA_NTP_SERVER ntpServerInfos: - 192.168.1.1 - google.com type: NTPSetting links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/ntpsettings?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/NTPSettingsPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/ntpsettings/{objectId}: get: deprecated: false description: '**Get the NTP setting associated with the specified ID.**' operationId: getNTPSettingsPolicy parameters: - description: The identifier of the settings policy to which the NTP setting belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: schema: $ref: '#/components/schemas/NTPSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the NTP setting associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateNTPSettingsPolicy parameters: - description: The identifier of the settings policy to which the NTP setting belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//ntpsettings/ ( Example payload for PUT on FTD NTP Setting. )' : value: id: ntpMode: SYNC_VIA_NTP_SERVER ntpServerInfos: - 192.168.1.1 - yahoo.co.in type: NTPSetting schema: $ref: '#/components/schemas/NTPSettingsPolicy' type: object description: Input representing NTP setting policy model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//ntpsettings/ ( Example payload for PUT on FTD NTP Setting. )' : value: id: links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/ntpsettings/ ntpMode: SYNC_VIA_NTP_SERVER ntpServerInfos: - 192.168.1.1 - yahoo.co.in type: NTPSetting schema: $ref: '#/components/schemas/NTPSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings: get: deprecated: false description: '**Get the list of all SNMP settings policies for a particular chassis.**' operationId: getAllSNMPSettingsPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: schema: $ref: '#/components/schemas/SNMPSettingsPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/snmpsettings/{objectId}: get: deprecated: false description: '**Get the SNMP platform settings policy associated with the specified ID.**' operationId: getSNMPSettingsPolicy parameters: - description: The identifier of the settings policy to which the SNMP setting belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/ftdplatformsettingspolicies/containerUUID/snmpsettings ( GET SNMP PlatformSettings )' : value: items: - communityString: commstring enableSNMPServers: true id: objectId links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/policy/ftdplatformsettingspolicies/containerUUID/snmpsettings/objectId port: '6758' snmpMgmtHosts: - ifSnmpHostMgmt: false interfaces: objects: - id: d7b9e8c8-7715-11ed-8c1c-b2953a72825d name: INTGRP1 type: InterfaceGroup - id: caa68736-7715-11ed-99ed-926d2ae48b48 name: SEZ1 type: InterfaceGroup ipAddress: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network poll: true port: '162' snmpVersion: SNMPv3 trap: false userName: user1 - communityString: commstring ifSnmpHostMgmt: false interfaces: objects: - id: caa68736-7715-11ed-99ed-926d2ae48b48 name: SEZ1 type: InterfaceGroup - id: d7b9e8c8-7715-11ed-8c1c-b2953a72825d name: INTGRP1 type: InterfaceGroup ipAddress: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network poll: true port: '162' snmpVersion: SNMPv1 trap: false - communityString: cisco communitystring: commustring ifSnmpHostMgmt: false interfaces: literals: - gig0 - gig1 objects: - id: d7b9e8c8-7715-11ed-8c1c-b2953a72825d name: INTGRP1 type: InterfaceGroup - id: caa68736-7715-11ed-99ed-926d2ae48b48 name: SEZ1 type: InterfaceGroup ipAddress: name: 2001::11 type: Network poll: true port: '162' snmpVersion: SNMPv2c trap: false snmpTrap: authentication: false clusterState: false coldStart: false connLimitReached: false cputhreshold: false cputhresholdIntervalInMins: '59' cputhresholdValueInPercent: '65' entityConfigChange: false failoverState: false fruinsert: false fruremove: false linkDown: false linkUp: false memThresholdValueInPercent: '69' memoryThreshold: false natPacketDiscard: false peerFlap: false syslog: false warmStart: false snmpv3Users: - authAlgoType: SHA authenticationPassword: cisco encPasswordType: Clear securityLevel: Auth userName: user - authAlgoType: SHA224 authenticationPassword: 63:69:73:63:6f:40:31:32:33 encPasswordType: Encrypted encryptionPassword: 63:69:73:63:6f:40:31:32:33 encryptionType: AES256 securityLevel: Priv userName: user2 - authAlgoType: SHA authenticationPassword: cisco encPasswordType: Clear encryptionPassword: cisco encryptionType: AES128 securityLevel: Priv userName: user3 sysAdminName: admin type: FTDSNMPPlatformSettings links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/policy/ftdplatformsettingspolicies/containerUUID/snmpsettings?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SNMPSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the SNMP platform settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateSNMPSettingsPolicy parameters: - description: The identifier of the settings policy to which the SNMP setting belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/ftdplatformsettingspolicies/containerUUID/snmpsettings/objectId ( PUT request to update SNMP Platform Settings )' : value: communityString: commstring enableSNMPServers: true id: objectId links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/policy/ftdplatformsettingspolicies/containerUUID/snmpsettings/objectId port: '6789' snmpMgmtHosts: - ifSnmpHostMgmt: false interfaces: objects: - id: d7b9e8c8-7715-11ed-8c1c-b2953a72825d name: INTGRP1 type: InterfaceGroup - id: caa68736-7715-11ed-99ed-926d2ae48b48 name: SEZ1 type: InterfaceGroup ipAddress: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network poll: true port: '162' snmpVersion: SNMPv3 trap: false userName: user1 - communityString: commstring ifSnmpHostMgmt: false interfaces: objects: - id: caa68736-7715-11ed-99ed-926d2ae48b48 name: SEZ1 type: InterfaceGroup - id: d7b9e8c8-7715-11ed-8c1c-b2953a72825d name: INTGRP1 type: InterfaceGroup ipAddress: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network poll: true port: '162' snmpVersion: SNMPv1 trap: false - communityString: commustring ifSnmpHostMgmt: false interfaces: literals: - gig0 - gig1 objects: - id: d7b9e8c8-7715-11ed-8c1c-b2953a72825d name: INTGRP1 type: InterfaceGroup - id: caa68736-7715-11ed-99ed-926d2ae48b48 name: SEZ1 type: InterfaceGroup ipAddress: name: 2001::11 type: Network poll: true port: '162' snmpVersion: SNMPv2c trap: false snmpTrap: authentication: false clusterState: false coldStart: false connLimitReached: false cputhreshold: false cputhresholdIntervalInMins: '59' cputhresholdValueInPercent: '65' entityConfigChange: false failoverState: false fruinsert: false fruremove: false linkDown: false linkUp: false memThresholdValueInPercent: '69' memoryThreshold: false natPacketDiscard: false peerFlap: false syslog: false warmStart: false snmpv3Users: - authAlgoType: SHA authenticationPassword: cisco encPasswordType: Clear securityLevel: Auth userName: user - authAlgoType: SHA224 authenticationPassword: 63:69:73:63:6f:40:31:32:33 encPasswordType: Encrypted encryptionPassword: 63:69:73:63:6f:40:31:32:33 encryptionType: AES256 securityLevel: Priv userName: user2 - authAlgoType: SHA authenticationPassword: cisco encPasswordType: Clear encryptionPassword: cisco encryptionType: AES128 securityLevel: Priv userName: user3 sysAdminName: admin type: FTDSNMPPlatformSettings schema: $ref: '#/components/schemas/SNMPSettingsPolicy' type: object description: Input representing SNMP setting policy model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/ftdplatformsettingspolicies/containerUUID/snmpsettings/objectId ( PUT request to update SNMP Platform Settings )' : value: communityString: commstring enableSNMPServers: true id: objectId links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/policy/ftdplatformsettingspolicies/containerUUID/snmpsettings/objectId port: '6789' snmpMgmtHosts: - ifSnmpHostMgmt: false interfaces: objects: - id: d7b9e8c8-7715-11ed-8c1c-b2953a72825d name: INTGRP1 type: InterfaceGroup - id: caa68736-7715-11ed-99ed-926d2ae48b48 name: SEZ1 type: InterfaceGroup ipAddress: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network poll: true port: '162' snmpVersion: SNMPv3 trap: false userName: user1 - communityString: commstring ifSnmpHostMgmt: false interfaces: objects: - id: caa68736-7715-11ed-99ed-926d2ae48b48 name: SEZ1 type: InterfaceGroup - id: d7b9e8c8-7715-11ed-8c1c-b2953a72825d name: INTGRP1 type: InterfaceGroup ipAddress: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network poll: true port: '162' snmpVersion: SNMPv1 trap: false - communityString: commustring ifSnmpHostMgmt: false interfaces: literals: - gig0 - gig1 objects: - id: d7b9e8c8-7715-11ed-8c1c-b2953a72825d name: INTGRP1 type: InterfaceGroup - id: caa68736-7715-11ed-99ed-926d2ae48b48 name: SEZ1 type: InterfaceGroup ipAddress: name: 2001::11 type: Network poll: true port: '162' snmpVersion: SNMPv2c trap: false snmpTrap: authentication: false clusterState: false coldStart: false connLimitReached: false cputhreshold: false cputhresholdIntervalInMins: '59' cputhresholdValueInPercent: '65' entityConfigChange: false failoverState: false fruinsert: false fruremove: false linkDown: false linkUp: false memThresholdValueInPercent: '69' memoryThreshold: false natPacketDiscard: false peerFlap: false syslog: false warmStart: false snmpv3Users: - authAlgoType: SHA authenticationPassword: cisco encPasswordType: Clear securityLevel: Auth userName: user - authAlgoType: SHA224 authenticationPassword: 63:69:73:63:6f:40:31:32:33 encPasswordType: Encrypted encryptionPassword: 63:69:73:63:6f:40:31:32:33 encryptionType: AES256 securityLevel: Priv userName: user2 - authAlgoType: SHA authenticationPassword: cisco encPasswordType: Clear encryptionPassword: cisco encryptionType: AES128 securityLevel: Priv userName: user3 sysAdminName: admin type: FTDSNMPPlatformSettings schema: $ref: '#/components/schemas/SNMPSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/sshaccesssettings: delete: deprecated: false description: '**Delete all SSH access settings policies for a particular device. _Check the response section for applicable examples (if any)._**' operationId: deleteMultipleFTDSSHAccessSettingsPolicy parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: true schema: type: boolean - description: 'To be used in conjunction with bulk=true for bulk deletion. Value is of format (including quotes): "ids:id1,id2,...".
ids is a comma-separated list of IDs to be deleted.' in: query name: filter required: false schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings/ ( Example payload for DELETE by ID of SSH Access Configurations. )' : value: id: 00505681-DBBD-0ed3-0000-176093659374 interfaces: literals: - sshaccess ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-176093659374 type: SSHAccessSetting ? 'Example 2 : DELETE /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings/bulk=true&filter= ( Example payload for bulk DELETE of SSH Access Configurations. )' : value: items: - id: 00505681-7733-0ed3-0000-021474836667 interfaces: literals: - ssh_int_lit ipAddress: literal: 6.5.6.7 links: self: https://u35c01p01-vrouter.cisco.com:17611/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-7733-0ed3-0000-004294967471/sshaccesssettings/00505681-7733-0ed3-0000-021474836667 type: SSHAccessSetting - id: 00505681-7733-0ed3-0000-021474836693 interfaces: literals: - int_literal ipAddress: literal: 1.5.6.7 links: self: https://u35c01p01-vrouter.cisco.com:17611/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-7733-0ed3-0000-004294967471/sshaccesssettings/00505681-7733-0ed3-0000-021474836693 type: SSHAccessSetting links: self: https://u35c01p01-vrouter.cisco.com:17611/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-7733-0ed3-0000-004294967471/sshaccesssettings?bulk=true&filter="ids:00505681-7733-0ed3-0000-021474836667,00505681-7733-0ed3-0000-021474836693" schema: $ref: '#/components/schemas/FTDSSHAccessSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get all SSH access settings policies for a particular device.**' operationId: getAllFTDSSHAccessSettingsPolicy parameters: - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/sshaccesssettings?offset=0&limit=25 ( Example payload for GET ALL of SSH Access Settings )' : value: items: - id: policy_uuid links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings/ type: SSHAccessSetting links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/sshaccesssettings paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies//sshaccesssettings?offset=0&limit=25&expanded=true ( GET All SSH Access Settings with expanded=true )' : value: items: - id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: objects: - id: f6341b4e-1c3b-11ef-929d-e048cf54efd4 name: int4 type: InterfaceGroup ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-008589934880 type: SSHAccessSetting links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies//sshaccesssettings?offset=0&limit=25&expanded=true paging: count: 1 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDSSHAccessSettingsPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create a SSH access settings policy. _Check the response section for applicable examples (if any)._**' operationId: createMultipleFTDSSHAccessSettingsPolicy parameters: - description: This parameter specifies that bulk post operation is being used in the query. This parameter is required for bulk save operations. in: query name: bulk required: false schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings?bulk=true ( Example payload for bulk POST of SSH Access Configurations. )' : value: - interfaces: objects: - id: f6341b4e-1c3b-11ef-929d-e048cf54efd4 name: int4 type: InterfaceGroup ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network type: SSHAccessSetting - interfaces: literals: - sshaccess ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network type: SSHAccessSetting ? 'Example 2 : POST /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings?bulk=false ( Example payload for POST of SSH Access Configuration. )' : value: interfaces: objects: - id: f6341b4e-1c3b-11ef-929d-e048cf54efd4 name: int4 type: InterfaceGroup ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network type: SSHAccessSetting schema: $ref: '#/components/schemas/FTDSSHAccessSettingsPolicy' type: object description: Input representation of SSH ACCESS policy object. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings?bulk=true ( Example payload for bulk POST of SSH Access Configurations. )' : value: items: - id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: objects: - id: f6341b4e-1c3b-11ef-929d-e048cf54efd4 name: int4 type: InterfaceGroup ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-008589934880 type: SSHAccessSetting - id: 00505681-DBBD-0ed3-0000-176093659268 interfaces: literals: - sshaccess ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-176093659268 type: SSHAccessSetting links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings?bulk=true ? 'Example 2 : POST /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings?bulk=false ( Example payload for POST of SSH Access Configuration. )' : value: id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: objects: - id: f6341b4e-1c3b-11ef-929d-e048cf54efd4 name: int4 type: InterfaceGroup ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-008589934880 type: SSHAccessSetting schema: $ref: '#/components/schemas/FTDSSHAccessSettingsPolicy' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify all SSH access settings policies for a particular device. _Check the response section for applicable examples (if any)._**' operationId: updateMultipleFTDSSHAccessSettingsPolicy parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: true schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings/ ( Example payload for PUT by ID of SSH Access Configuration. )' : value: id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: literals: - access ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network type: SSHAccessSetting ? 'Example 2 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings?bulk=true ( Example payload for bulk PUT of SSH Access configurations. )' : value: - id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: objects: - id: f6341b4e-1c3b-11ef-929d-e048cf54efd4 name: int4 type: InterfaceGroup ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network type: SSHAccessSetting - id: 00505681-DBBD-0ed3-0000-176093659268 interfaces: literals: - sshaccess ipAddress: literal: 6.5.6.7 type: SSHAccessSetting schema: $ref: '#/components/schemas/FTDSSHAccessSettingsPolicy' type: object description: Input representing SSH access settings policy model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings/ ( Example payload for PUT by ID of SSH Access Configuration. )' : value: id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: literals: - access ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-008589934880 type: SSHAccessSetting ? 'Example 2 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings?bulk=true ( Example payload for bulk PUT of SSH Access configurations. )' : value: items: - id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: objects: - id: f6341b4e-1c3b-11ef-929d-e048cf54efd4 name: int4 type: InterfaceGroup ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-008589934880 type: SSHAccessSetting - id: 00505681-DBBD-0ed3-0000-176093659268 interfaces: literals: - sshaccess ipAddress: literal: 6.5.6.7 links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-176093659268 type: SSHAccessSetting links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings?bulk=true schema: $ref: '#/components/schemas/FTDSSHAccessSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/sshaccesssettings/{objectId} : delete: deprecated: false description: '**Delete the SSH access settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteFTDSSHAccessSettingsPolicy parameters: - description: The identifier of the platform settings policy to which this SSH access policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings/ ( Example payload for DELETE by ID of SSH Access Configurations. )' : value: id: 00505681-DBBD-0ed3-0000-176093659374 interfaces: literals: - sshaccess ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-176093659374 type: SSHAccessSetting ? 'Example 2 : DELETE /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings/bulk=true&filter= ( Example payload for bulk DELETE of SSH Access Configurations. )' : value: items: - id: 00505681-7733-0ed3-0000-021474836667 interfaces: literals: - ssh_int_lit ipAddress: literal: 6.5.6.7 links: self: https://u35c01p01-vrouter.cisco.com:17611/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-7733-0ed3-0000-004294967471/sshaccesssettings/00505681-7733-0ed3-0000-021474836667 type: SSHAccessSetting - id: 00505681-7733-0ed3-0000-021474836693 interfaces: literals: - int_literal ipAddress: literal: 1.5.6.7 links: self: https://u35c01p01-vrouter.cisco.com:17611/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-7733-0ed3-0000-004294967471/sshaccesssettings/00505681-7733-0ed3-0000-021474836693 type: SSHAccessSetting links: self: https://u35c01p01-vrouter.cisco.com:17611/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-7733-0ed3-0000-004294967471/sshaccesssettings?bulk=true&filter="ids:00505681-7733-0ed3-0000-021474836667,00505681-7733-0ed3-0000-021474836693" schema: $ref: '#/components/schemas/FTDSSHAccessSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the SSH access settings policy associated with the specified ID.**' operationId: getFTDSSHAccessSettingsPolicy parameters: - description: The identifier of the platform settings policy to which this SSH access policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: schema: $ref: '#/components/schemas/FTDSSHAccessSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the SSH access settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateFTDSSHAccessSettingsPolicy parameters: - description: The identifier of the platform settings policy to which this SSH access policy belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings/ ( Example payload for PUT by ID of SSH Access Configuration. )' : value: id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: literals: - access ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network type: SSHAccessSetting ? 'Example 2 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings?bulk=true ( Example payload for bulk PUT of SSH Access configurations. )' : value: - id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: objects: - id: f6341b4e-1c3b-11ef-929d-e048cf54efd4 name: int4 type: InterfaceGroup ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network type: SSHAccessSetting - id: 00505681-DBBD-0ed3-0000-176093659268 interfaces: literals: - sshaccess ipAddress: literal: 6.5.6.7 type: SSHAccessSetting schema: $ref: '#/components/schemas/FTDSSHAccessSettingsPolicy' type: object description: Input representing SSH access settings policy model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings/ ( Example payload for PUT by ID of SSH Access Configuration. )' : value: id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: literals: - access ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-008589934880 type: SSHAccessSetting ? 'Example 2 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//sshaccesssettings?bulk=true ( Example payload for bulk PUT of SSH Access configurations. )' : value: items: - id: 00505681-DBBD-0ed3-0000-008589934880 interfaces: objects: - id: f6341b4e-1c3b-11ef-929d-e048cf54efd4 name: int4 type: InterfaceGroup ipAddress: object: id: cb7116e8-66a6-480b-8f9b-295191a0940a name: any-ipv4 type: Network links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-008589934880 type: SSHAccessSetting - id: 00505681-DBBD-0ed3-0000-176093659268 interfaces: literals: - sshaccess ipAddress: literal: 6.5.6.7 links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings/00505681-DBBD-0ed3-0000-176093659268 type: SSHAccessSetting links: self: https://u35c01p01-vrouter.cisco.com:17623/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-DBBD-0ed3-0000-008589934649/sshaccesssettings?bulk=true schema: $ref: '#/components/schemas/FTDSSHAccessSettingsPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/basicloggingsetups : get: deprecated: false description: '**Get the basic Syslog logging setup associated with a given Platform Setting policy.**' operationId: getAllSyslogBasicLoggingSetup parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies//syslog/basicloggingsetups?offset=0&limit=25&expanded=true ( GET All Basic Logging Setup Settings with expanded=true )' : value: items: - enableDebugMesgAsSyslog: false enableEMBLEMFormat: false enableFlash: true enableLogging: true enableLoggingFailover: true ftpServerInfo: interfaceGroups: - id: f51bc1de-2317-11ef-bd5b-c6ca67ef1199 name: interface type: InterfaceGroup ipAddress: id: 00505681-5CDB-0ed3-0000-214748364852 name: host1 type: Network password: '***********' path: /test/itc userName: user id: 00505681-5CDB-0ed3-0000-231928234223 internalBuffMemSizeInBytes: 4097 links: self: https://u35c01p01-vrouter.cisco.com:13606/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-5CDB-0ed3-0000-231928234223/syslog/basicloggingsetups/00505681-5CDB-0ed3-0000-231928234223 loggingToFMCLogLevel: ERR loggingToFMCType: VPN maxFlashForLoggingInKB: 1000 minFreePreservedSpaceInKB: 10 type: BasicLoggingSetup links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies//syslog/basicloggingsetups?offset=0&limit=25&expanded=true paging: count: 1 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SyslogBasicLoggingSetupListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/basicloggingsetups/{objectId} : get: deprecated: false description: '**Get the basic Syslog logging setting associated with a given Platform Setting policy and specified ID.**' operationId: getSyslogBasicLoggingSetup parameters: - description: The identifier of the platform settings policy to which this Syslog setting belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/syslog/basicloggingsetups?offset=0&limit=25 ( Example payload for GET by Id on FTD Basic Logging Setup Settings )' : value: items: - enableDebugMesgAsSyslog: false enableEMBLEMFormat: true enableFlash: true enableLogging: true enableLoggingFailover: true ftpServerInfo: interfaceGroups: - id: f51bc1de-2317-11ef-bd5b-c6ca67ef1199 name: interface type: InterfaceGroup ipAddress: id: 00505681-5CDB-0ed3-0000-214748364852 name: host1 type: Network password: '***********' path: /test/itc userName: user id: 00505681-5CDB-0ed3-0000-231928234223 internalBuffMemSizeInBytes: 4097 links: self: https://u35c01p01-vrouter.cisco.com:13606/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftdplatformsettingspolicies/00505681-5CDB-0ed3-0000-249108103248/syslog/basicloggingsetups/00505681-5CDB-0ed3-0000-249108103248 loggingToFMCLogLevel: ERR loggingToFMCType: VPN maxFlashForLoggingInKB: 3086 minFreePreservedSpaceInKB: 1024 type: BasicLoggingSetup links: self: /fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/syslog/basicloggingsetups?offset=0&limit=25 paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SyslogBasicLoggingSetup' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the basic Syslog logging setting associated with a given Platform Setting policy and specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateSyslogBasicLoggingSetup parameters: - description: The identifier of the platform settings policy to which this Syslog setting belongs. in: path name: objectId required: true schema: type: string - description: Boolean indicating whether to change the entire object or only certain attributes of it. The default value is FALSE. in: query name: partialUpdate required: false schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/basicloggingsetups/ ( Example payload for PUT on Basic Logging Setup . )' : value: enableDebugMesgAsSyslog: false enableEMBLEMFormat: false enableFlash: true enableLogging: true enableLoggingFailover: true ftpServerInfo: interfaceGroups: - id: f51bc1de-2317-11ef-bd5b-c6ca67ef1199 name: interface type: InterfaceGroup ipAddress: id: 00505681-5CDB-0ed3-0000-214748364852 name: host1 type: Network password: '***********' path: /test/itc userName: user id: 00505681-5CDB-0ed3-0000-231928234223 internalBuffMemSizeInBytes: 4097 loggingToFMCLogLevel: ERR loggingToFMCType: VPN maxFlashForLoggingInKB: 1000 minFreePreservedSpaceInKB: 30 type: BasicLoggingSetup ? 'Example 2 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/basicloggingsetups/ ( Example payload for Partial PUT on Basic Logging Setup . )' : value: enableDebugMesgAsSyslog: false enableEMBLEMFormat: true enableLogging: true enableLoggingFailover: true id: 00505681-5CDB-0ed3-0000-231928234223 internalBuffMemSizeInBytes: 4097 loggingToFMCLogLevel: ERR loggingToFMCType: VPN maxFlashForLoggingInKB: 1100 type: BasicLoggingSetup schema: $ref: '#/components/schemas/SyslogBasicLoggingSetup' type: object description: Input representing syslog basic logging setup model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/basicloggingsetups/ ( Example payload for PUT on Basic Logging Setup . )' : value: enableDebugMesgAsSyslog: false enableEMBLEMFormat: false enableFlash: true enableLogging: true enableLoggingFailover: true ftpServerInfo: interfaceGroups: - id: f51bc1de-2317-11ef-bd5b-c6ca67ef1199 name: interface type: InterfaceGroup ipAddress: id: 00505681-5CDB-0ed3-0000-214748364852 name: host1 type: Network password: '***********' path: /test/itc userName: user id: 00505681-5CDB-0ed3-0000-231928234223 internalBuffMemSizeInBytes: 4097 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/basicloggingsetups/ loggingToFMCLogLevel: ERR loggingToFMCType: VPN maxFlashForLoggingInKB: 1000 minFreePreservedSpaceInKB: 30 type: BasicLoggingSetup ? 'Example 2 : PUT /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/basicloggingsetups/ ( Example payload for Partial PUT on Basic Logging Setup . )' : value: enableDebugMesgAsSyslog: false enableEMBLEMFormat: true enableFlash: true enableLogging: true enableLoggingFailover: true ftpServerInfo: interfaceGroups: - id: f51bc1de-2317-11ef-bd5b-c6ca67ef1199 name: interface type: InterfaceGroup ipAddress: id: 00505681-5CDB-0ed3-0000-214748364852 name: host1 type: Network password: '***********' path: /test/itc userName: user id: 00505681-5CDB-0ed3-0000-231928234223 internalBuffMemSizeInBytes: 4097 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/basicloggingsetups/ loggingToFMCLogLevel: ERR loggingToFMCType: VPN maxFlashForLoggingInKB: 1100 minFreePreservedSpaceInKB: 1024 type: BasicLoggingSetup schema: $ref: '#/components/schemas/SyslogBasicLoggingSetup' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists: delete: deprecated: false description: '**Delete all of the Syslog EventList Platform settings policies for a particular device. _Check the response section for applicable examples (if any)._**' operationId: deleteMultipleFTDSyslogEventListPolicy parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: true schema: type: boolean - description: 'To be used in conjunction with bulk=true for bulk deletion. Value is of format (including quotes): "ids:id1,id2,...".
ids is a comma-separated list of IDs to be deleted.' in: query name: filter required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: schema: $ref: '#/components/schemas/FTDSyslogEventListPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get all Syslog EventList settings policies for a particular device.**' operationId: getAllFTDSyslogEventListPolicy parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/syslog/eventlists?offset=0&limit=25&expanded=true ( Example payload for GET ALL on FTD Syslog Event List Settings )' : value: items: - eventClass: - classes: APPLICATION_FIREWALL severity: ALERTS id: objectUUID links: self: fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/syslog/eventlists/objectUUID messageIds: - '100093' - '100074' name: EventList-1 type: EventList - eventClass: - classes: APPLICATION_FIREWALL severity: ALERTS id: objectUUID links: self: api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/syslog/eventlists/objectUUID messageIds: - '100071' - '100081' name: EventList-2 type: EventList - eventClass: - classes: CARD_MANAGEMENT severity: NOTIFICATIONS id: objectUUID links: self: api/fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/syslog/eventlists/objectUUID messageIds: - '1000040' - '1000050' name: EventList-3 type: EventList links: self: fmc_config/v1/domain/DomainUUID/policy/ftdplatformsettingspolicies/containerUUID/syslog/eventlists?offset=0&limit=25&expanded=true paging: count: 10 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDSyslogEventListPolicyListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create a Syslog EventList policy. _Check the response section for applicable examples (if any)._**' operationId: createMultipleFTDSyslogEventListPolicy parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: false schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/FTDSyslogEventListPolicy' type: object description: Input representation of Syslog EventList policy object. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FTDSyslogEventListPolicy' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify all of the Syslog EventList Platform settings policies for a particular device. _Check the response section for applicable examples (if any)._**' operationId: updateMultipleFTDSyslogEventListPolicy parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: true schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId} ( Example payload for PUT on Syslog EventList )' : value: eventClass: - classes: APPLICATION_FIREWALL severity: ALERTS id: 00505681-5F2A-0ed3-0000-047244640330 messageIds: - '100093' - '100074' name: EventList-1 type: EventList schema: $ref: '#/components/schemas/FTDSyslogEventListPolicy' type: object description: Input representing Syslog EventList setting policy model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId} ( Example payload for PUT on Syslog EventList )' : value: eventClass: - classes: APPLICATION_FIREWALL severity: ALERTS id: objectId links: self: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId} messageIds: - '100093' - '100074' name: EventList-1 type: EventList schema: $ref: '#/components/schemas/FTDSyslogEventListPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId} : delete: deprecated: false description: '**Delete the Syslog EventList settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteFTDSyslogEventListPolicy parameters: - description: The identifier of the platform settings policy to which this Syslog EventList setting belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: schema: $ref: '#/components/schemas/FTDSyslogEventListPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get the Syslog EventList settings policy associated with the specified ID.**' operationId: getFTDSyslogEventListPolicy parameters: - description: The identifier of the platform settings policy to which this Syslog EventList setting belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId} ( GET Syslog EventList )' : value: eventClass: - classes: APPLICATION_FIREWALL severity: ALERTS id: objectId links: self: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId} messageIds: - '100093' - '100074' name: EventList-1 type: EventList schema: $ref: '#/components/schemas/FTDSyslogEventListPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify the Syslog EventList settings policy associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateFTDSyslogEventListPolicy parameters: - description: The identifier of the platform settings policy to which this Syslog EventList setting belongs. in: path name: objectId required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId} ( Example payload for PUT on Syslog EventList )' : value: eventClass: - classes: APPLICATION_FIREWALL severity: ALERTS id: 00505681-5F2A-0ed3-0000-047244640330 messageIds: - '100093' - '100074' name: EventList-1 type: EventList schema: $ref: '#/components/schemas/FTDSyslogEventListPolicy' type: object description: Input representing Syslog EventList setting policy model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId} ( Example payload for PUT on Syslog EventList )' : value: eventClass: - classes: APPLICATION_FIREWALL severity: ALERTS id: objectId links: self: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/eventlists/{objectId} messageIds: - '100093' - '100074' name: EventList-1 type: EventList schema: $ref: '#/components/schemas/FTDSyslogEventListPolicy' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy 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 ? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingdestinations : delete: deprecated: false description: '**Delete all of the Syslog EventList Platform settings policies for a particular device. _Check the response section for applicable examples (if any)._**' operationId: deleteMultipleSyslogLoggingDestination parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: true schema: type: boolean - description: 'To be used in conjunction with bulk=true for bulk deletion. Value is of format (including quotes): "ids:id1,id2,...".
ids is a comma-separated list of IDs to be deleted.' in: query name: filter required: true schema: type: string - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : DELETE /api/fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ ( Example payload for delete by id the configurations of Logging Destination . )' : value: allEventConfig: filterCriteria: SEVERITY value: emergencies id: 00505681-BBEB-0ed3-0000-034359738566 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ loggingDestination: SYSLOG_SERVERS specificEventConfig: - class: AUTH severity: EMERG type: LoggingDestination schema: $ref: '#/components/schemas/SyslogLoggingDestination' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy get: deprecated: false description: '**Get all Syslog EventList settings policies for a particular device.**' operationId: getAllSyslogLoggingDestination parameters: - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID - $ref: '#/components/parameters/offset' name: offset - $ref: '#/components/parameters/limit' name: limit - $ref: '#/components/parameters/expanded' name: expanded responses: '200': content: application/json: examples: ? 'Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingdestinations?offset=0&limit=25 ( Example payload for GET ALL on SysLog LoggingDestinations Settings )' : value: items: - id: policy_uuid links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ type: LoggingDestination links: self: /api/fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingdestinations paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingdestinations?offset=0&limit=25&expanded=true ( GET All SysLog LoggingDestinations Settings with expanded=true )' : value: items: - allEventConfig: filterCriteria: SEVERITY value: emergencies id: 00505681-BBEB-0ed3-0000-021474836624 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ loggingDestination: CONSOLE specificEventConfig: - class: AUTH severity: EMERG type: LoggingDestination - allEventConfig: filterCriteria: SEVERITY value: emergencies id: 00505681-BBEB-0ed3-0000-034359738566 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ loggingDestination: SYSLOG_SERVERS specificEventConfig: - class: AUTH severity: EMERG type: LoggingDestination links: self: /fmc_config/v1/domain/{domainUUID}/policy/ftdplatformsettingspolicies/{containerUUID}/syslog/loggingdestinations?offset=0&limit=25&expanded=true paging: count: 1 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/SyslogLoggingDestinationListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy post: deprecated: false description: '**Create a Syslog EventList policy. _Check the response section for applicable examples (if any)._**' operationId: createMultipleSyslogLoggingDestination parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: false schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: schema: $ref: '#/components/schemas/SyslogLoggingDestination' type: object description: Input representation of Syslog Logging Destination policy object. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/SyslogLoggingDestination' type: object description: Created default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Policy put: deprecated: false description: '**Modify all of the Syslog EventList Platform settings policies for a particular device. _Check the response section for applicable examples (if any)._**' operationId: updateMultipleSyslogLoggingDestination parameters: - description: Boolean indicating whether this is a bulk operation. in: query name: bulk required: true schema: type: boolean - description: UUID of the ticket for tracking the configuration changes. in: header name: ticket-id required: false schema: type: string - description: The container id under which this specific resource is contained. in: path name: containerUUID required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ ( Example payload for PUT by ID on Logging destination. )' : value: allEventConfig: filterCriteria: SEVERITY value: errors id: 00505681-BBEB-0ed3-0000-021474836624 loggingDestination: CONSOLE specificEventConfig: - class: AUTH severity: EMERG type: LoggingDestination ? 'Example 2 : PUT /api/fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations?bulk=true ( Example payload for put bulk the configurations of Logging Destination. )' : value: - allEventConfig: filterCriteria: SEVERITY value: errors id: 00505681-BBEB-0ed3-0000-021474836624 loggingDestination: CONSOLE specificEventConfig: - class: AUTH severity: EMERG type: LoggingDestination - allEventConfig: filterCriteria: SEVERITY value: emergencies id: 00505681-BBEB-0ed3-0000-034359738566 loggingDestination: SYSLOG_SERVERS specificEventConfig: - class: AUTH severity: EMERG type: LoggingDestination - allEventConfig: filterCriteria: SEVERITY value: errors id: 00505681-BBEB-0ed3-0000-098784247922 loggingDestination: EMAIL specificEventConfig: - class: WEBVPN severity: EMERG type: LoggingDestination schema: $ref: '#/components/schemas/SyslogLoggingDestination' type: object description: Input representation of Syslog Logging Destination policy object. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ ( Example payload for PUT by ID on Logging destination. )' : value: allEventConfig: filterCriteria: SEVERITY value: errors id: 00505681-BBEB-0ed3-0000-021474836624 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ loggingDestination: CONSOLE specificEventConfig: - class: AUTH severity: EMERG type: LoggingDestination ? 'Example 2 : PUT /api/fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations?bulk=true ( Example payload for put bulk the configurations of Logging Destination. )' : value: items: - items: - allEventConfig: filterCriteria: SEVERITY value: errors id: 00505681-BBEB-0ed3-0000-021474836624 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ loggingDestination: CONSOLE specificEventConfig: - class: AUTH severity: EMERG type: LoggingDestination - allEventConfig: filterCriteria: SEVERITY value: emergencies id: 00505681-BBEB-0ed3-0000-034359738566 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ loggingDestination: SYSLOG_SERVERS specificEventConfig: - class: AUTH severity: EMERG type: LoggingDestination - allEventConfig: filterCriteria: SEVERITY value: errors id: 00505681-BBEB-0ed3-0000-098784247922 links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies//syslog/loggingdestinations/ loggingDestination: EMAIL specificEventConfig: - class: WEBVPN severity: EMERG type: LoggingDestination links: self: /fmc_config/v1/domain//policy/ftdplatformsettingspolicies/