TunnelResourceObjectWithState - Cloud Security API

{"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":"Get the information about the tunnel in the organization.\nTo include the tunnel state information in the response, set the `includeState` request query parameter to `true`.","properties":{"id":{"type":"integer","readOnly":true,"description":"The tunnel resource ID. Use this ID as a reference for subsequent requests.","example":1122321},"uri":{"type":"string","description":"Resource URI","readOnly":true,"example":"/organization/2345432/tunnels/1122321"},"name":{"type":"string","description":"The display name of the tunnel. The tunnel name is required, cannot exceed 50 characters in length,\nand cannot have any special characters other than spaces and hyphens.","example":"Site01Tunnel"},"siteOriginId":{"type":"integer","description":"Site Origin ID to associate 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":"The metadata for the tunnel object that relates to service internals.","readOnly":true,"properties":{"state":{"title":"tunnelState","description":"The tunnel state information.","properties":{"tunnelId":{"type":"string","readOnly":true,"description":"The tunnel ID.","example":"163367136"},"status":{"type":"string","readOnly":true,"description":"The high-level tunnel status:\n* up - the tunnel is active\n* down - the tunnel is inactive\n* failed - the tunnel is in a failed state\n* unknown - the status is unknown and pending updated information\n","enum":["UP","DOWN","FAILED","UNKNOWN"],"example":"UP"},"dc":{"type":"string","readOnly":true,"description":"The domain name that is associate with the data center.","example":"chi1.edc"},"dcName":{"type":"string","readOnly":true,"description":"The name of the data center.","example":"Equinix Chicago"},"dcDesc":{"type":"string","readOnly":true,"description":"The city and country or region of the data center.","example":"Chicago, Illinois - US"},"ikeState":{"type":"string","readOnly":true,"description":"IKE SA State:\n * CREATED\n * CONNECTING\n * ESTABLISHED\n * PASSIVE\n * REKEYING\n * REKEYED\n * DELETING\n * DESTROYING\n","enum":["CREATED","CONNECTING","ESTABLISHED","PASSIVE","REKEYING","REKEYED","DELETING","DESTROYING"],"example":"ESTABLISHED","$$ref":"#/components/schemas/ikeState"},"ipsecState":{"type":"string","readOnly":true,"description":"IPSec/Child SA State:\n * CREATED\n * ROUTED\n * INSTALLING\n * INSTALLED\n * UPDATING\n * REKEYING\n * REKEYED\n * RETRYING\n * DELETING\n * DELETED\n * DESTROYING\n","enum":["CREATED","ROUTED","INSTALLING","INSTALLED","UPDATING","REKEYING","REKEYED","RETRYING","DELETING","DELETED","DESTROYING"],"example":"INSTALLED","$$ref":"#/components/schemas/ipsecState"},"peerId":{"type":"string","readOnly":true,"description":"The remote peer IKE ID.","example":"unique-value@1234567-234567812-umbrella.com"},"peerIp":{"type":"string","readOnly":true,"description":"The remote peer IP.","example":"198.18.195.1"},"localIp":{"type":"string","readOnly":true,"description":"The public IP address, which is assigned to an endpoint device (ISR, Viptela).","example":"198.25.43.19"},"peerPort":{"type":"string","readOnly":true,"description":"The port number of the remote peer.","example":"4500"},"ike":{"title":"tunnelIKEState","description":"The tunnel IKE session state.","properties":{"age":{"type":"string","readOnly":true,"description":"The age of the established state in seconds.","example":"6194"},"dhGroup":{"type":"string","readOnly":true,"description":"The IKE Diffie-Hellman group.","example":"MODP_2048"},"prfAlgo":{"type":"string","readOnly":true,"description":"The IKE pseudo random function.","example":"PRF_HMAC_SHA1"},"encAlgo":{"type":"string","readOnly":true,"description":"The IKE encryption algorithm.","example":"AES_CBC"},"initiatorSpi":{"type":"string","readOnly":true,"description":"The hex encoded initiator SPI or cookie.","example":"cf065c564a511834"},"responderSpi":{"type":"string","readOnly":true,"description":"The hex encoded responder SPI or cookie.","example":"a3cd5c8533c80069"}}},"ipsec":{"title":"tunnelIPSecState","description":"The tunnel IPsec session state.","properties":{"age":{"type":"string","readOnly":true,"description":"The age of the installed state in seconds.","example":"6194"},"integrityAlgo":{"type":"string","readOnly":true,"description":"The ESP or AH integrity algorithm name.","example":"HMAC_SHA1_96"},"encAlgo":{"type":"string","readOnly":true,"description":"The ESP encryption algorithm name.","example":"NULL"},"encKeySize":{"type":"string","readOnly":true,"description":"The ESP encryption key size (optional field; not available with NULL encryption.","example":"128"},"spiIn":{"type":"string","readOnly":true,"description":"The hex encoded inbound SPI.","example":"c6ef7503"},"spiOut":{"type":"string","readOnly":true,"description":"The hex encoded outbound SPI.","example":"00010102"},"peerSelectors":{"type":"array","readOnly":true,"description":"The peer traffic selectors.","items":{"type":"string","description":"The selector expression.","example":"0.0.0.0/0"}}}},"data":{"title":"tunnelDataState","description":"The state of the tunnel's data plane.","properties":{"packetsIn":{"type":"string","readOnly":true,"description":"The number of processed input packets (tunnel ingress).","example":"10"},"bytesIn":{"type":"string","readOnly":true,"description":"The number of processed input bytes (tunnel ingress).","example":"1000"},"idleTimeIn":{"type":"string","readOnly":true,"description":"The idle time (seconds since last inbound packet).","example":"100"},"packetsOut":{"type":"string","readOnly":true,"description":"The number of processed output packets (tunnel egress).","example":"10"},"bytesOut":{"type":"string","readOnly":true,"description":"The number of processed output bytes (tunnel egress).","example":"1000"},"idleTimeOut":{"type":"string","readOnly":true,"description":"The idle time (seconds since last outbound packet).","example":"100"},"initialized":{"type":"string","readOnly":true,"description":"The time when packet and byte counters were initialized to 0.","example":"2023-10-19T22:15:12.765623734Z"}}},"modifiedAt":{"type":"string","readOnly":true,"format":"date-time","description":"The date and time (UTC time with milliseconds) when the tunnel's state was last updated.","example":"2018-06-13T16:07:07.222Z"}}}}},"createdAt":{"type":"string","format":"date-time","description":"The date and n time (UTC time with milliseconds) when the tunnel was created.","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"}},"$$ref":"#/components/schemas/TunnelResourceObjectWithState","title":"TunnelResourceObjectWithState"}}