Get tunnel route by IP

client.ZeroTrust.Networks.Routes.IPs.Get(ctx, ip, params) (*Teamnet, error)

GET/accounts/{account_id}/teamnet/routes/ip/{ip}

Fetches routes that contain the given IP address.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Cloudflare One Networks WriteCloudflare One Networks ReadCloudflare Tunnel WriteCloudflare Tunnel Read

ParametersExpand Collapse

ip string

params NetworkRouteIPGetParams

AccountID param.Field[string]

Path param: Cloudflare account ID

maxLength32

DefaultVirtualNetworkFallback param.Field[bool]Optional

Query param: When the virtual_network_id parameter is not provided the request filter will default search routes that are in the default virtual network for the account. If this parameter is set to false, the search will include routes that do not have a virtual network.

VirtualNetworkID param.Field[string]Optional

Query param: UUID of the virtual network.

formatuuid

ReturnsExpand Collapse

type Teamnet struct{…}

ID stringOptional

UUID of the route.

maxLength36

Comment stringOptional

Optional remark describing the route.

maxLength100

CreatedAt TimeOptional

Timestamp of when the resource was created.

formatdate-time

DeletedAt TimeOptional

Timestamp of when the resource was deleted. If null, the resource has not been deleted.

formatdate-time

Network stringOptional

The private IPv4 or IPv6 range connected by the route, in CIDR notation.

TunType TeamnetTunTypeOptional

The type of tunnel.

One of the following:

const TeamnetTunTypeCfdTunnel TeamnetTunType = "cfd_tunnel"

const TeamnetTunTypeWARPConnector TeamnetTunType = "warp_connector"

const TeamnetTunTypeWARP TeamnetTunType = "warp"

const TeamnetTunTypeMagic TeamnetTunType = "magic"

const TeamnetTunTypeIPSec TeamnetTunType = "ip_sec"

const TeamnetTunTypeGRE TeamnetTunType = "gre"

const TeamnetTunTypeCNI TeamnetTunType = "cni"

TunnelID stringOptional

UUID of the tunnel.

formatuuid

maxLength36

TunnelName stringOptional

A user-friendly name for a tunnel.

VirtualNetworkID stringOptional

UUID of the virtual network.

formatuuid

VirtualNetworkName stringOptional

A user-friendly name for the virtual network.

maxLength256

Get tunnel route by IP

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/zero_trust"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  teamnet, err := client.ZeroTrust.Networks.Routes.IPs.Get(
    context.TODO(),
    "10.1.0.137",
    zero_trust.NetworkRouteIPGetParams{
      AccountID: cloudflare.F("699d98642c564d2e855e9661899b7252"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", teamnet.ID)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "comment": "Example comment for this route.",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2009-11-10T23:00:00.000000Z",
    "network": "172.16.0.0/16",
    "tun_type": "cfd_tunnel",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "tunnel_name": "blog",
    "virtual_network_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "virtual_network_name": "us-east-1-vpc"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "comment": "Example comment for this route.",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2009-11-10T23:00:00.000000Z",
    "network": "172.16.0.0/16",
    "tun_type": "cfd_tunnel",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "tunnel_name": "blog",
    "virtual_network_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "virtual_network_name": "us-east-1-vpc"
  },
  "success": true
}