List Regions for Network Tunnel Groups - Cloud Security Gov

{"type":"api","title":"List Regions for Network Tunnel Groups","meta":{"id":"/apps/pubhub/media/cloud-security-gov/9ead083ce611c254ac9201d1e76003bd3d4b4b6b/b608b63c-8f99-3c50-a490-501c84f4f333","info":{"title":"Cisco Secure Access for Government Network Tunnel Groups and Regions API","description":"Manage the Network Tunnel Groups in the organization.","version":"1.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Network Tunnel Groups","description":"Network Tunnel Groups API endpoints"},{"name":"Network Tunnel Groups Regions","description":"Network Tunnel Groups Regions API endpoints"},{"name":"Network Tunnel Groups State","description":"Network Tunnel Groups State API endpoints"},{"name":"Network Tunnel Groups Peer State","description":"Network Tunnel Groups Peer State API endpoints"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/deployments/network-tunnel-groups-overview.md","uri":"secure-access-api-reference-network-tunnel-groups-overview"}},"openapi":"3.0.3","servers":[{"url":"https://api.secureaccessfed.cisco.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.secureaccessfed.cisco.com/auth/v2/token","scopes":{"deployments.networktunnelgroups:read":"Read network tunnel groups deployments","deployments.networktunnelgroups:write":"Write network tunnel groups deployments","deployments.regions:read":"Read regions for network tunnel groups deployments"}}}}}},"spec":{"summary":"List Regions for Network Tunnel Groups","operationId":"listNetworkTunnelGroupRegions","tags":["Network Tunnel Groups Regions","Secure Access"],"description":"List the available regions for the Network Tunnel Groups.","security":[{"oauthFlow":["deployments.regions:read"]}],"parameters":[{"name":"filters","in":"query","description":"Filter the regions by one or more properties: `peerIP` or `latitude` and `longitude`.\n\n* **peerIP** - List the regions in ascending order based on the distance of the regions to the location of the given peer IP.\n You can only set a public IP for `peerIP`. If `latitude` and `longitude` are provided, `peerIP` is ignored.\n* **latitude** and **longitude** - List the regions in ascending order based on the distance of the regions from the provided coordinates.\n When included with a request, set both `latitude` and `longitude`.\n\nSpecify the filters in the JSON format.\n\nExamples:\n\n```\n{\n \"peerIP\": \"25.123.22.10\"\n}\n```\n\n```\n{\n \"latitude\": 39.0299604,\n \"longitude\": -77.4771231\n}\n```","schema":{"type":"object","description":"The filters for the regions of the Network Tunnel Groups.\nYou can set either the `peerIP` filter or both the `latitude` and `longitude` filters.","properties":{"peerIP":{"type":"string","description":"Provide the public IP address of a peer (tunnel).\nList the regions sorted in ascending order and based on the regional distances from\nthe geolocation of the provided peer IP.\nOnly a public IP is allowed as the value of `peerIP`. `peerIP` is ignored if you provide `latitude` and `longitude`.\u003c/br\u003e\n**Note:** If you set the `latitude` and `longitude` filters, the `peerIP` filter is ignored.","example":"25.123.22.10"},"latitude":{"type":"number","format":"double","description":"List the regions in ascending order based on the distance of the regions from the provided coordinates.\n**Note:** Set both the `latitude` and `longitude` filters together.","example":39.0299604},"longitude":{"type":"number","format":"double","description":"List the regions in ascending order based on the distance of the regions from the provided coordinates.","example":-77.4771231},"status":{"type":"string","description":"Specify either all regions or only the regions that can accept new tunnels.\nSet the value of the `status` filter as `all` or `available`.\nThe default value is `available`.","example":"all"}},"$$ref":"#/components/schemas/filtersRegionsObject"},"$$ref":"#/components/parameters/filtersRegions"}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The list of regions associated with the tunnel.","properties":{"regions":{"type":"array","description":"The list of regions for the Network Tunnel Groups.","items":{"type":"object","description":"The properties of the region.","required":["name","region","description","continent"],"properties":{"name":{"type":"string","description":"The name of a region.","readOnly":true,"example":"US East 1"},"region":{"type":"string","description":"The ID of a region.","readOnly":true,"example":"us-east-1"},"description":{"type":"string","description":"The country and location of a region.","readOnly":true,"example":"US West (N. California)"},"continent":{"type":"string","readOnly":true,"description":"The continent where the region is located.","example":"North America"}}}},"bgp":{"type":"object","properties":{"asNumber":{"type":"string","description":"The BGP autonomous system (AS) number.","readOnly":true,"example":"12345"},"peerIPs":{"type":"array","description":"The list of BGP peer IP addresses.","items":{"type":"string","description":"A border gateway protocol (BGP) peer IP address.","readOnly":true,"example":"10.20.0.1"},"example":["10.20.0.1","10.20.0.2"]},"peerRange":{"type":"string","description":"The range of BGP peer addresses.","readOnly":true,"example":"169.254.0.0/24"}},"example":{"asNumber":"12345","peerIPs":["10.20.0.1"],"peerRange":"169.254.0.0/24"},"$$ref":"#/components/schemas/bgp"}},"example":{"regions":[{"name":"US East 1","region":"us-east-1","description":"US East (N. Virginia)","continent":"North America"},{"name":"US West 2","region":"us-west-2","description":"US West (N. California)","continent":"North America"}],"bgp":{"asNumber":"64512","peerIPs":["169.254.0.9","169.254.0.5"],"peerRange":"169.254.0.0/24"}},"$$ref":"#/components/schemas/regionList"},"example":{"regions":[{"name":"US East 1","region":"us-east-1","description":"US East (N. Virginia)","continent":"North America"},{"name":"US West 2","region":"us-west-2","description":"US West (N. California)","continent":"North America"}],"bgp":{"asNumber":"64512","peerIPs":["169.254.0.9","169.254.0.5"],"peerRange":"169.254.0.0/24"}}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Provided IP is in the 'Do Not Sell My Personal Information' list"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}},{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Validation Error"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"},"validationErrors":{"type":"object","properties":{"peerIP":{"type":"string","description":"Indicates the problem with the peer IP in query param.","example":"Filter value must be a public IPv4."},"latitude":{"type":"number","format":"double","description":"Indicates the problem with latitude.","example":39.0299604},"longitude":{"type":"number","format":"double","description":"Indicates the problem with longitude.","example":-77.4771231}}}}}],"$$ref":"#/components/schemas/400RegionsError"}}},"$$ref":"#/components/responses/400RegionsError"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Authorization token is invalid."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}},"$$ref":"#/components/schemas/401Error"}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Access Forbidden"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}},"$$ref":"#/components/schemas/403Error"}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}},"$$ref":"#/components/schemas/404Error"}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}},"$$ref":"#/components/schemas/500Error"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"listNetworkTunnelGroupRegions","method":"get","path":"/regions"}}