Get All Vpn Advanced Settings - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All Vpn Advanced Settings","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 advanced settings inside a VPN Site To Site Topology.**","operationId":"getAllVpnAdvancedSettings","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/ftds2svpns/containerUUID/advancedsettings ( Success: Test GET ALL success )":{"value":{"items":[{"id":"005056A9-097E-0ed3-0000-021474836554","links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-097E-0ed3-0000-008589935150/advancedsettings/005056A9-097E-0ed3-0000-021474836554"},"type":"AdvancedSettings"}],"links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-097E-0ed3-0000-008589935150/advancedsettings?offset=0&limit=1"},"paging":{"count":1,"limit":1,"offset":0,"pages":1}}},"Example 2 : GET /fmc_config/v1/domain/DomainUUID/policy/ftds2svpns/containerUUID/endpoints?expanded=true ( Success: Test GET ALL success with expanded=true )":{"value":{"items":[{"advancedIkeSetting":{"cookieChallenge":"CUSTOM","enableAggressiveMode":false,"enableNotificationOnTunnelDisconnect":false,"identitySentToPeer":"AUTO_OR_DN","peerIdentityValidation":"REQUIRED","percentageOfSAsAllowedInNegotiation":100,"thresholdToChallengeIncomingCookies":50},"advancedIpsecSetting":{"enableFragmentationBeforeEncryption":true,"maximumTransmissionUnitAging":{"enabled":false}},"advancedTunnelSetting":{"bypassAccessControlTrafficForDecryptedTraffic":false,"certificateMapSettings":{"useCertMapConfiguredInEndpointToDetermineTunnel":false,"useCertificateOuToDetermineTunnel":true,"useIkeIdentityOuToDetermineTunnel":true,"usePeerIpAddressToDetermineTunnel":true},"enableSpokeToSpokeConnectivityThrougHub":false,"natKeepaliveMessageTraversal":{"enabled":true,"intervalSeconds":20},"vpnIdleTimeout":{"enabled":true,"timeoutMinutes":20}},"id":"005056A9-097E-0ed3-0000-021474836554","links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-097E-0ed3-0000-008589935150/advancedsettings/005056A9-097E-0ed3-0000-021474836554"},"type":"AdvancedSettings"}],"links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-097E-0ed3-0000-008589935150/advancedsettings?offset=0&limit=1&expanded=true"},"paging":{"count":1,"limit":1,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","properties":{"advancedIkeSetting":{"type":"object","properties":{"cookieChallenge":{"enum":["CUSTOM","ALWAYS","NEVER"],"type":"string"},"enableAggressiveMode":{"type":"boolean"},"enableNotificationOnTunnelDisconnect":{"type":"boolean"},"identitySentToPeer":{"enum":["IP_ADDRESS","HOST_NAME","AUTO_OR_DN"],"type":"string"},"ikeKeepaliveSettings":{"type":"object","properties":{"ikeKeepalive":{"enum":["DISABLED","ENABLED","ENABLED_INFINITE"],"type":"string"},"retryInterval":{"format":"int32","type":"integer"},"threshold":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IIkeKeepaliveSettings"},"maximumNumberOfSAsAllowed":{"format":"int32","type":"integer"},"peerIdentityValidation":{"enum":["DO_NOT_CHECK","REQUIRED","IF_SUPPORTED_BY_CERT"],"type":"string"},"percentageOfSAsAllowedInNegotiation":{"format":"int32","type":"integer"},"thresholdToChallengeIncomingCookies":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IS2SIkeAdvanceSettingModel"},"advancedIpsecSetting":{"type":"object","description":"Contains site-to-site IPSec advanced settings.","properties":{"enableFragmentationBeforeEncryption":{"description":"Indicates whether to enable transmission unit fragmentation before encryption.","type":"boolean"},"maximumTransmissionUnitAging":{"description":"Duration of the MTU aging window.","type":"object","properties":{"enabled":{"description":"Indicates whether MTU aging is enabled.","type":"boolean"},"resetIntervalMinutes":{"description":"Interval before resetting the MTU.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMaximumTransmissionUnitAging"}},"$$ref":"#/components/schemas/IS2SIpSecAdvanceSettingModel"},"advancedTunnelSetting":{"type":"object","description":"Contains advanced site-to-site tunnel settings.","properties":{"bypassAccessControlTrafficForDecryptedTraffic":{"description":"Indicates whether to bypass access control for decrypted traffic.","type":"boolean"},"certificateMapSettings":{"description":"Contains certificate map settings.","type":"object","properties":{"useCertMapConfiguredInEndpointToDetermineTunnel":{"type":"boolean"},"useCertificateOuToDetermineTunnel":{"type":"boolean"},"useIkeIdentityOuToDetermineTunnel":{"type":"boolean"},"usePeerIpAddressToDetermineTunnel":{"type":"boolean"}},"$$ref":"#/components/schemas/ICertificateMapSettings"},"enableSpokeToSpokeConnectivityThroughHub":{"description":"Indicates whether spoke-to-spoke connectivity is enabled through the hub.","type":"boolean"},"natKeepaliveMessageTraversal":{"description":"Object representing keepalive message traversal information.","type":"object","properties":{"enabled":{"type":"boolean"},"intervalSeconds":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/INatKeepaliveTraversal"},"vpnIdleTimeout":{"description":"Object representing VPN Idle timeout information.","type":"object","properties":{"enabled":{"description":"Specifies Vpn Idle time out field is enabled or not ","type":"boolean"},"timeoutMinutes":{"description":"Specifies the time out field in minutes","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IVpnIdleTimeout"}},"$$ref":"#/components/schemas/IS2STunnelAdvanceSettingModel"},"description":{"type":"string"},"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/VpnAdvancedSettings"},"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/VpnAdvancedSettingsListContainer"}}},"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":"getAllVpnAdvancedSettings","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/advancedsettings"}}