Create Vpn Endpoint - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Vpn Endpoint","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":"**Create an endpoint in a Site to Site VPN topology. _Check the response section for applicable examples (if any)._**","operationId":"createVpnEndpoint","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"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/DomainUUID/policy/ftds2svpns/containerUUID/endpoints ( POST of Endpoint with FMC managed FTD device )":{"value":{"connectionType":"BIDIRECTIONAL","device":{"id":"933e077a-64cc-11e8-9be7-da0d15a02570","name":"192.168.0.32","type":"Device"},"interface":{"id":"005056A9-9F80-0ed3-0000-008589934781","name":"inside","type":"PhysicalInterface"},"isLocalTunnelIdEnabled":true,"localIdentityString":"bgl-asa-umb-sg@1234-5204-umbrella.com","localIdentityType":"EMAIL","overrideRemoteVpnFilter":false,"peerType":"PEER","protectedNetworks":{"networks":[{"id":"95916354-5aa1-4057-8eea-b42a5a207abc","name":"IPv4-Private-10.0.0.0-8","type":"Network"}]},"type":"EndPoint","vpnFilterAcl":{"id":"00505681-0FCA-0ed3-0000-008589934599","name":"ACL-Ext-1","type":"ExtendedAccessList"}}},"Example 2 : POST /fmc_config/v1/domain/DomainUUID/policy/ftds2svpns/containerUUID/endpoints ( POST of Endpoint with extranet )":{"value":{"extranet":true,"extranetInfo":{"ipAddress":"10.0.0.1","name":"10.0.0.1"},"extranetType":"GENERIC","peerType":"PEER","protectedNetworks":{"networks":[{"id":"95916354-5aa1-4057-8eea-b42a5a207abc","name":"IPv4-Private-10.0.0.0-8","type":"Network"}]},"type":"EndPoint"}},"Example 3 : POST /fmc_config/v1/domain/DomainUUID/policy/ftds2svpns/containerUUID/endpoints ( POST of dVTI Endpoint with FMC managed FTD device )":{"value":{"allowIncomingIKEv2Routes":true,"connectionType":"BIDIRECTIONAL","device":{"id":"933e077a-64cc-11e8-9be7-da0d15a02570","name":"192.168.0.32","type":"Device"},"interface":{"id":"0050568C-AE52-0ed3-0000-038654705851","name":"dVTI","type":"VTI"},"ipv4PoolForSpokeVTI":{"id":"0050568C-33AA-0ed3-0000-021474836530","name":"pool1","type":"IPv4AddressPool"},"isLocalTunnelIdEnabled":true,"localIdentityString":"bgl-asa-umb-sg@1234-5204-umbrella.com","localIdentityType":"EMAIL","overrideRemoteVpnFilter":false,"peerType":"HUB","protectedNetworks":{},"sendTunnelInterfaceIpToPeer":true,"tunnelSourceInterface":{"id":"0050568C-AE52-0ed3-0000-004294968311","name":"outside","type":"PhysicalInterface"},"tunnelSourceIpv6Address":"IPv6Address","type":"EndPoint","vpnFilterAcl":{"id":"00505681-0FCA-0ed3-0000-008589934599","name":"ACL-Ext-1","type":"ExtendedAccessList"}}},"Example 4 : POST /fmc_config/v1/domain/DomainUUID/policy/ftds2svpns/containerUUID/endpoints?bulk=true ( bulk POST example for Endpoints in VPN topology )":{"value":[{"connectionType":"BIDIRECTIONAL","device":{"id":"933e077a-64cc-11e8-9be7-da0d15a02570","name":"192.168.0.32","type":"Device"},"interface":{"id":"005056A9-9F80-0ed3-0000-008589934781","name":"inside","type":"PhysicalInterface"},"isLocalTunnelIdEnabled":false,"overrideRemoteVpnFilter":false,"peerType":"PEER","protectedNetworks":{"networks":[{"id":"95916354-5aa1-4057-8eea-b42a5a207abc","name":"IPv4-Private-10.0.0.0-8","type":"Network"}]},"type":"EndPoint","vpnFilterAcl":{"id":"00505681-0FCA-0ed3-0000-008589934599","name":"ACL-Ext-1","type":"ExtendedAccessList"}},{"extranet":true,"extranetInfo":{"ipAddress":"10.0.0.1","name":"10.0.0.1"},"extranetType":"GENERIC","peerType":"PEER","protectedNetworks":{"networks":[{"id":"95916354-5aa1-4057-8eea-b42a5a207abc","name":"IPv4-Private-10.0.0.0-8","type":"Network"}]},"type":"EndPoint"}]}},"schema":{"type":"object","description":"Description of VpnEndpoint.","properties":{"ExemptedProtectedNetworks":{"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"},"allowIncomingIKEv2Routes":{"type":"boolean"},"backupInterfaces":{"items":{"type":"object","properties":{"interface":{"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"},"ipv6InterfaceAddress":{"type":"string"},"isLocalTunnelIdEnabled":{"type":"boolean"},"localIdentityString":{"type":"string"},"localIdentityType":{"type":"string"},"publicIpAddress":{"type":"string"}},"$$ref":"#/components/schemas/IVpnBackupInterface"},"type":"array"},"bgpAsNumber":{"format":"int32","type":"integer"},"connectionType":{"description":"Specifies the connection type of the peer. Allowed values are ORIGINATE_ONLY, ANSWER_ONLY, BIDIRECTIONAL.","type":"string"},"datacenter":{"type":"object","properties":{"city":{"type":"string"},"continent":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"ipAddress":{"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/IUmbrellaDataCenter"},"description":{"description":"Description of VpnEndpoint.","type":"string"},"device":{"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"},"dynamicRRIEnabled":{"description":"Boolean indicating whether the endpoint is enabled with Dynamic Reverse Route Injection or not.","type":"boolean"},"enableNATExempt":{"type":"boolean"},"enableNatTraversal":{"type":"boolean"},"extranet":{"description":"Boolean indicating whether the endpoint is a managed FTD device or extranet.","type":"boolean"},"extranetInfo":{"type":"object","description":"Contains VPN extranet information.","properties":{"endpointTunnelIp":{"type":"string"},"ipAddress":{"description":"IP address of the VPN endpoint.","type":"string"},"isDynamicIP":{"description":"Indicates whether the VPN endpoint has a dynamic IP.","type":"boolean"},"name":{"description":"User chosen resource name.","type":"string"}},"$$ref":"#/components/schemas/IVpnExtranetInfo"},"id":{"description":"Unique identifier (UUID) representing the VpnEndpoint.","type":"string"},"insideInterface":{"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"},"interface":{"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"},"ipv4PoolsForSpokeVti":{"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"},"ipv6InterfaceAddress":{"type":"string"},"ipv6PoolsForSpokeVti":{"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"},"isLocalTunnelIdEnabled":{"description":"Flag to send local identity to peer, if set to false - values for localIdentityType and localIdentityString will be ignored","type":"boolean"},"isPrimaryHub":{"type":"boolean"},"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"},"localIdentityString":{"description":"String for unique tunnel ID applicable only for key-id and email-id","type":"string"},"localIdentityType":{"description":"Type of local Identity - ADDRESS | AUTO | EMAIL | HOSTNAME |KEYID","type":"string"},"metadata":{"description":"Object representing metadata attributes for the VpnEndpoint.","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":{"description":"User-specified name of the VpnEndpoint.","type":"string"},"nattedInterfaceAddress":{"description":"The public or the natted IP address of the endpoint if the vpn interface is a private IP","type":"string"},"overrideRemoteVpnFilter":{"description":"A boolean flag to indicate if the VPN filter on the hub needs to be overridden","type":"boolean"},"peerType":{"description":"Specifies the peer type. Allowed values are PEER, HUB, SPOKE.","type":"string"},"protectedNetworks":{"type":"object","description":"Contains information about VPN networks.","properties":{"acl":{"description":"Access control list of the network.","type":"object","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"},"networks":{"description":"Represents networks in the VPN.","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"}},"$$ref":"#/components/schemas/IVpnProtectedNetwork"},"remoteVpnFilterAclObject":{"description":"Extended ACL reference configured on the SPOKE to override VPN filter on the HUB","type":"object","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"},"secureAccessRegion":{"type":"string"},"sendTunnelInterfaceIpToPeer":{"type":"boolean"},"tunnelAuthenticationSettings":{"type":"object","properties":{"ikev1AuthSettings":{"type":"object","properties":{"authType":{"enum":["MANUAL_PRE_SHARED_KEY","AUTOMATIC_PRE_SHARED_KEY","CERTIFICATE"],"type":"string"},"ikev1PresharedKey":{"type":"string"}},"$$ref":"#/components/schemas/ITunnelIkev1AuthSettings"},"ikev2AuthSettings":{"type":"object","properties":{"authType":{"enum":["MANUAL_PRE_SHARED_KEY","AUTOMATIC_PRE_SHARED_KEY","CERTIFICATE"],"type":"string"},"ikev2PresharedKey":{"type":"string"}},"$$ref":"#/components/schemas/ITunnelIkev2AuthSettings"}},"$$ref":"#/components/schemas/ITunnelAuthenticationSettings"},"tunnelSourceInterface":{"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"},"tunnelSourceIpv6Address":{"type":"string"},"type":{"description":"The unique type of the VpnEndpoint.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"},"vpnFilterAcl":{"description":"Extended ACL reference for the VPN Filter ACL","type":"object","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"}},"$$ref":"#/components/schemas/VpnEndpoint"}}},"description":"Input representation of Endpoint.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 4 : POST /fmc_config/v1/domain/DomainUUID/policy/ftds2svpns/containerUUID/endpoints?bulk=true ( bulk POST example for Endpoints in VPN topology )":{"value":{"items":[{"connectionType":"BIDIRECTIONAL","device":{"id":"933e077a-64cc-11e8-9be7-da0d15a02570","name":"192.168.0.32","type":"Device"},"id":"005056A9-6FFE-0ed3-0000-141733920770","interface":{"id":"005056A9-9F80-0ed3-0000-008589934781","name":"inside","type":"PhysicalInterface"},"isLocalTunnelIdEnabled":false,"links":{"self":"\u003cfmc_ip\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-6FFE-0ed3-0000-004294967298/endpoints/005056A9-6FFE-0ed3-0000-141733920770"},"name":"192.168.0.23","peerType":"PEER","protectedNetworks":{"networks":[{"id":"95916354-5aa1-4057-8eea-b42a5a207abc","name":"IPv4-Private-10.0.0.0-8","type":"Network"}]},"type":"EndPoint","vpnFilterAcl":{"id":"00505681-0FCA-0ed3-0000-008589934599","name":"ACL-Ext-1","type":"ExtendedAccessList"}},{"extranet":true,"extranetInfo":{"ipAddress":"10.0.0.1","name":"10.0.0.1"},"extranetType":"GENERIC","id":"005056A9-6FFE-0ed3-0000-141733920771","links":{"self":"\u003cfmc_ip\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-6FFE-0ed3-0000-004294967298/endpoints/005056A9-6FFE-0ed3-0000-141733920771"},"peerType":"PEER","protectedNetworks":{"networks":[{"id":"95916354-5aa1-4057-8eea-b42a5a207abc","name":"IPv4-Private-10.0.0.0-8","type":"Network"}]},"type":"EndPoint"}],"links":{"self":"\u003cfmc_ip\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/ftds2svpns/005056A9-6FFE-0ed3-0000-004294967298/endpoints?bulk=true"}}}},"schema":{"type":"object","description":"Description of VpnEndpoint.","properties":{"ExemptedProtectedNetworks":{"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"},"allowIncomingIKEv2Routes":{"type":"boolean"},"backupInterfaces":{"items":{"type":"object","properties":{"interface":{"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"},"ipv6InterfaceAddress":{"type":"string"},"isLocalTunnelIdEnabled":{"type":"boolean"},"localIdentityString":{"type":"string"},"localIdentityType":{"type":"string"},"publicIpAddress":{"type":"string"}},"$$ref":"#/components/schemas/IVpnBackupInterface"},"type":"array"},"bgpAsNumber":{"format":"int32","type":"integer"},"connectionType":{"description":"Specifies the connection type of the peer. Allowed values are ORIGINATE_ONLY, ANSWER_ONLY, BIDIRECTIONAL.","type":"string"},"datacenter":{"type":"object","properties":{"city":{"type":"string"},"continent":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"ipAddress":{"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/IUmbrellaDataCenter"},"description":{"description":"Description of VpnEndpoint.","type":"string"},"device":{"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"},"dynamicRRIEnabled":{"description":"Boolean indicating whether the endpoint is enabled with Dynamic Reverse Route Injection or not.","type":"boolean"},"enableNATExempt":{"type":"boolean"},"enableNatTraversal":{"type":"boolean"},"extranet":{"description":"Boolean indicating whether the endpoint is a managed FTD device or extranet.","type":"boolean"},"extranetInfo":{"type":"object","description":"Contains VPN extranet information.","properties":{"endpointTunnelIp":{"type":"string"},"ipAddress":{"description":"IP address of the VPN endpoint.","type":"string"},"isDynamicIP":{"description":"Indicates whether the VPN endpoint has a dynamic IP.","type":"boolean"},"name":{"description":"User chosen resource name.","type":"string"}},"$$ref":"#/components/schemas/IVpnExtranetInfo"},"id":{"description":"Unique identifier (UUID) representing the VpnEndpoint.","type":"string"},"insideInterface":{"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"},"interface":{"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"},"ipv4PoolsForSpokeVti":{"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"},"ipv6InterfaceAddress":{"type":"string"},"ipv6PoolsForSpokeVti":{"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"},"isLocalTunnelIdEnabled":{"description":"Flag to send local identity to peer, if set to false - values for localIdentityType and localIdentityString will be ignored","type":"boolean"},"isPrimaryHub":{"type":"boolean"},"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"},"localIdentityString":{"description":"String for unique tunnel ID applicable only for key-id and email-id","type":"string"},"localIdentityType":{"description":"Type of local Identity - ADDRESS | AUTO | EMAIL | HOSTNAME |KEYID","type":"string"},"metadata":{"description":"Object representing metadata attributes for the VpnEndpoint.","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":{"description":"User-specified name of the VpnEndpoint.","type":"string"},"nattedInterfaceAddress":{"description":"The public or the natted IP address of the endpoint if the vpn interface is a private IP","type":"string"},"overrideRemoteVpnFilter":{"description":"A boolean flag to indicate if the VPN filter on the hub needs to be overridden","type":"boolean"},"peerType":{"description":"Specifies the peer type. Allowed values are PEER, HUB, SPOKE.","type":"string"},"protectedNetworks":{"type":"object","description":"Contains information about VPN networks.","properties":{"acl":{"description":"Access control list of the network.","type":"object","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"},"networks":{"description":"Represents networks in the VPN.","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"}},"$$ref":"#/components/schemas/IVpnProtectedNetwork"},"remoteVpnFilterAclObject":{"description":"Extended ACL reference configured on the SPOKE to override VPN filter on the HUB","type":"object","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"},"secureAccessRegion":{"type":"string"},"sendTunnelInterfaceIpToPeer":{"type":"boolean"},"tunnelAuthenticationSettings":{"type":"object","properties":{"ikev1AuthSettings":{"type":"object","properties":{"authType":{"enum":["MANUAL_PRE_SHARED_KEY","AUTOMATIC_PRE_SHARED_KEY","CERTIFICATE"],"type":"string"},"ikev1PresharedKey":{"type":"string"}},"$$ref":"#/components/schemas/ITunnelIkev1AuthSettings"},"ikev2AuthSettings":{"type":"object","properties":{"authType":{"enum":["MANUAL_PRE_SHARED_KEY","AUTOMATIC_PRE_SHARED_KEY","CERTIFICATE"],"type":"string"},"ikev2PresharedKey":{"type":"string"}},"$$ref":"#/components/schemas/ITunnelIkev2AuthSettings"}},"$$ref":"#/components/schemas/ITunnelAuthenticationSettings"},"tunnelSourceInterface":{"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"},"tunnelSourceIpv6Address":{"type":"string"},"type":{"description":"The unique type of the VpnEndpoint.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"},"vpnFilterAcl":{"description":"Extended ACL reference for the VPN Filter ACL","type":"object","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"}},"$$ref":"#/components/schemas/VpnEndpoint"}}},"description":"Created"},"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":"createVpnEndpoint","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/ftds2svpns/{containerUUID}/endpoints"}}