{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/6de27b83-cd76-3f18-9e4a-e121ea0a8b86","info":{"title":"Cisco Umbrella Network Tunnels API","description":"Manage the network tunnels in the organization.","version":"2.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Data Center"},{"name":"Organization Tunnel"},{"name":"Debugging"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/network-tunnels-overview.md","uri":"umbrella-api-reference-network-tunnels-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"deployments.tunnels:write":"Write deployments tunnels","deployments.tunnels:read":"Read deployments tunnels","deployments.datacenters:read":"Read deployments datacenters"}}}}}},"spec":{"type":"object","description":"The tunnel resource object.","properties":{"id":{"type":"integer","readOnly":true,"description":"The tunnel resource ID, use this ID as reference for subsequent requests.","example":1122321},"uri":{"type":"string","description":"Resource URI","readOnly":true,"example":"/tunnels/1122321"},"name":{"type":"string","description":"The display name of the tunnel. The tunnel name is required, cannot exceed 50 characters in length,\nand can't have any special characters other than spaces and hyphens.","example":"Site01Tunnel"},"siteOriginId":{"type":"integer","description":"The site origin ID, which is associated with the tunnel.","example":123456},"client":{"type":"object","description":"The tunnel client's configuration metadata.","properties":{"deviceType":{"type":"string","description":"The type of device where the tunnel originates. The default value is `other`.","enum":["ASA","FTD","ISR","Meraki MX","Viptela cEdge","Viptela vEdge","other"],"$$ref":"#/components/schemas/deviceType"},"authentication":{"type":"object","description":"The authentication context of the client.","properties":{"type":{"type":"string","enum":["PSK"],"example":"PSK","readOnly":true},"parameters":{"type":"object","properties":{"id":{"type":"string","description":"The PSK ID. If an IP address is used as the ID, the IP address is the value of this field.","readOnly":true,"example":"admin@2561066-237952254-umbrella.com"},"modifiedAt":{"type":"string","format":"date-time","readOnly":true,"example":"2018-06-13T16:07:07.222Z","description":"The data and time (timestamp) when the tunnel was updated.","$$ref":"#/components/schemas/modifiedAt"}},"$$ref":"#/components/schemas/parameters"}},"$$ref":"#/components/schemas/authentication"}},"$$ref":"#/components/schemas/TunnelClientMetadata"},"transport":{"type":"object","properties":{"protocol":{"description":"The tunnel transport protocol. The default is IPSec.","type":"string","enum":["IPSec"],"readOnly":true,"example":"IPSec"}}},"serviceType":{"type":"string","description":"The type of service to associate with the tunnel. The default value is `SIG`.","enum":["SIG","Private Access"],"example":"SIG","$$ref":"#/components/schemas/serviceType"},"networkCIDRs":{"type":"array","description":"Enter IPv4 ranges and CIDR addresses.\nIf `serviceType` is SIG, add all public and private address ranges used internally\nby your organization. Overrides Umbrella's default behavior,\nwhich allows traffic that is destined for RFC-1918 addresses to return through the tunnel.\nIf `serviceType` is Private Access, this field is required.\nThe 0.0.0.0/0 address range is not allowed.","items":{"type":"string","description":"An IPv4 CIDR range.","example":"111.222.39.1/32"},"example":["123.111.222.25/24","111.222.39.1/32"],"$$ref":"#/components/schemas/networkCIDRs"},"meta":{"type":"object","description":"Metadata for the tunnel object, relating to service internals.","readOnly":true},"createdAt":{"type":"string","description":"The time when the tunnel was created.","format":"date-time","readOnly":true,"example":"2018-06-13T16:07:07.222Z"},"modifiedAt":{"type":"string","format":"date-time","readOnly":true,"example":"2018-06-13T16:07:07.222Z","description":"The data and time (timestamp) when the tunnel was updated.","$$ref":"#/components/schemas/modifiedAt"}},"example":{"id":1122321,"uri":"/tunnels/1122321","name":"Site01Tunnel","siteOriginId":123456,"client":{"deviceType":"ASA","authentication":{"type":"PSK","parameters":{"id":"admin@2561066-237952254-umbrella.com","modifiedAt":"2018-06-13T16:07:07.222Z"}}},"transport":{"protocol":"IPSec"},"serviceType":"SIG","networkCIDRs":["123.111.222.25/24","111.222.39.1/32"],"meta":{},"createdAt":"2018-06-13T16:07:07.222Z","modifiedAt":"2018-06-13T16:07:07.222Z"},"$$ref":"#/components/schemas/TunnelResourceObject","title":"TunnelResourceObject"}}