Get All FTDRA Vpn IP Sec Crypto Map Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All FTDRA Vpn IP Sec Crypto Map Model","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get the list containing a single IPSEC Crypto Map Setting entry of the remote access VPN topology.**","operationId":"getAllFTDRAVpnIPSecCryptoMapModel","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"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_config/v1/domain/DomainUUID/policy/ravpns/containerUUID/ipseccryptomaps ( Get all RAVpnIpSecCryptoMaps )":{"value":{"items":[{"clientServicesPort":443,"doNotFragmentPolicy":"Set","enableClientServices":true,"enableRRI":false,"id":"00505681-968B-0ed3-0000-008589934945","ikev2IpsecProposals":[{"id":"00505681-968B-0ed3-0000-000000002012","name":"DES_SHA-1","type":"TransformSet2"}],"interfaceObject":{"id":"993f929a-483c-11ec-a4bd-abcd19b0b50c","name":"sz_1","type":"SecurityZone"},"lifeTimeKilobytes":4608001,"lifeTimeSeconds":28801,"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"rest"},"parentPolicy":{"id":"00505681-968B-0ed3-0000-008589934794","name":"rapvn_1","type":"RAVpn"},"timestamp":1637562863227},"perfectForwardSecracy":{"enabled":true,"modulusGroup":14},"tfcPackets":{"burstBytes":0,"enabled":false,"payloadBytes":0,"timeoutSeconds":0},"type":"RaVpnIPsecCryptoMap","validateIncomingIcmpErrorMessage":false}],"links":{"self":"/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ravpns"},"paging":{"count":1,"limit":25,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"A model representing Ipsec Crypto Map Settings definition.","properties":{"clientServicesPort":{"description":"Specify the port number for client services to download AnyConnect updates.","format":"int32","type":"integer"},"description":{"type":"string"},"doNotFragmentPolicy":{"description":"Define how the IPsec subsystem handles large packets that have the do-not-fragment (DF) bit set in the IP header.","enum":["SET","COPY","CLEAR","NONE"],"type":"string"},"enableClientServices":{"description":"The Client Services Server provides HTTPS (SSL) access to allow the AnyConnect Downloader to receive software upgrades.","type":"boolean"},"enableRRI":{"description":"Enable static routes to be automatically inserted into the routing process for those networks and hosts protected by a remote tunnel endpoint","type":"boolean"},"id":{"description":"Unique identifier representing response object.","type":"string"},"ikev2IpsecProposals":{"description":"Select the transform sets to specify which authentication and encryption algorithms will be used to secure the traffic in the tunnel.","items":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":"array"},"interfaceObject":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"lifeTimeKilobytes":{"description":"The volume of traffic (in kilobytes) that can pass between IPsec peers using a given security association before it expires.","format":"int32","type":"integer"},"lifeTimeSeconds":{"description":"The lifetime of the security association (SA), in seconds.","format":"int32","type":"integer"},"links":{"description":"Object containing related links.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"description":"Object representing metadata properties of Ipsec Crypto Map Settings.","type":"object","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"type":"string"},"perfectForwardSecracy":{"description":"The unique session key protects the exchange from subsequent decryption.","type":"object","properties":{"enabled":{"type":"boolean"},"modulusGroup":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IFTDRAVpnIPSecPFSModel"},"tfcPackets":{"description":"Enable dummy TFC packets that mask the traffic profile which traverses the tunnel.","type":"object","properties":{"burstBytes":{"format":"int32","type":"integer"},"enabled":{"type":"boolean"},"payloadBytes":{"format":"int32","type":"integer"},"timeoutSeconds":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IFTDRAVpnIPSecTfcPacketsModel"},"type":{"description":"Type associated with resource: RaVpnIPsecCrytoMap.","type":"string"},"validateIncomingIcmpErrorMessage":{"description":"Choose whether to validate ICMP error messages received through an IPsec tunnel and destined for an interior host on the private network","type":"boolean"},"version":{"type":"string"}},"$$ref":"#/components/schemas/FTDRAVpnIPSecCryptoMapModel"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/FTDRAVpnIPSecCryptoMapModelListContainer"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Policy"],"__originalOperationId":"getAllFTDRAVpnIPSecCryptoMapModel","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ravpns/{containerUUID}/ipseccryptomaps"}}