Get S 2 S Vpn Summary Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get S 2 S Vpn Summary 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 all the configured S2S VPN in the system, with short summary along with the health of the tunnels.**","operationId":"getS2SVpnSummaryModel","parameters":[{"description":"The filter criteria for which the details have to be fetched. The following filters are supported - device:{deviceId};name:{Topology name};routeBased:{true|false};includeSubDomains:{true|false}. User can enter one or many filters.","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"}},{"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/s2svpnsummaries ( Get S2S VPN summary. )":{"value":{"items":[{"activeTunnelCount":6,"downTunnelCount":4,"id":"asdddf0","ikeV1Enabled":true,"ikeV2Enabled":true,"name":"DummyData0","outOfSync":false,"routeBased":false,"topologyType":"HUB_AND_SPOKE","totalTunnelCount":10,"type":"FTDS2SVpn"},{"activeTunnelCount":6,"downTunnelCount":4,"id":"asdddf0","ikeV1Enabled":true,"ikeV2Enabled":true,"name":"DummyData0","outOfSync":false,"routeBased":false,"topologyType":"HUB_AND_SPOKE","totalTunnelCount":10,"type":"FTDS2SVpn"}],"paging":{"count":1,"limit":2,"offset":0,"pages":8}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Contains information about the site-to-site VPN settings used by the Firepower Threat Defense device.","properties":{"activeTunnelCount":{"description":" total count of active tunnel","format":"int32","type":"integer"},"deploymentPending":{"description":"After edit of Topology whether configuration is deployed or not","type":"boolean"},"description":{"description":"User provided description.","type":"string"},"downTunnelCount":{"description":" total count of down tunnel","format":"int32","type":"integer"},"id":{"description":"Unique identifier representing resource.","type":"string"},"ikeV1Enabled":{"description":"Boolean indicating whether the VPN connection is using internet Key Exchange v1.","type":"boolean"},"ikeV2Enabled":{"description":"Boolean indicating whether the VPN connection is using internet Key Exchange v2.","type":"boolean"},"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"},"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":{"description":"User chosen resource name.","type":"string"},"routeBased":{"description":"Policy based or Route based","type":"boolean"},"topologyType":{"description":"Indicates the type of topolgy used by the VPN.","enum":["HUB_AND_SPOKE","POINT_TO_POINT","FULL_MESH","SASE_TUNNEL","AUTO_VPN","SSE_TUNNEL"],"type":"string"},"totalTunnelCount":{"description":"total count of configured tunnel","format":"int32","type":"integer"},"type":{"type":"string"},"unknownTunnelCount":{"description":" total count of unknown tunnel","format":"int32","type":"integer"},"version":{"type":"string"}},"$$ref":"#/components/schemas/S2SVpnSummaryModel"},"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/S2SVpnSummaryModelListContainer"}}},"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":"getS2SVpnSummaryModel","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/s2svpnsummaries"}}