Get hostname route

client.ZeroTrust.Networks.HostnameRoutes.Get(ctx, hostnameRouteID, query) (*HostnameRoute, error)

GET/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}

Get a hostname route.

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

hostnameRouteID string

The hostname route ID.

formatuuid

query NetworkHostnameRouteGetParams

AccountID param.Field[string]

Cloudflare account ID

maxLength32

ReturnsExpand Collapse

type HostnameRoute struct{…}

ID stringOptional

The hostname route ID.

formatuuid

Comment stringOptional

An optional description of the hostname route.

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

Hostname stringOptional

The hostname of the route.

TunType HostnameRouteTunTypeOptional

The type of tunnel.

One of the following:

const HostnameRouteTunTypeCfdTunnel HostnameRouteTunType = "cfd_tunnel"

const HostnameRouteTunTypeWARPConnector HostnameRouteTunType = "warp_connector"

const HostnameRouteTunTypeWARP HostnameRouteTunType = "warp"

const HostnameRouteTunTypeMagic HostnameRouteTunType = "magic"

const HostnameRouteTunTypeIPSec HostnameRouteTunType = "ip_sec"

const HostnameRouteTunTypeGRE HostnameRouteTunType = "gre"

const HostnameRouteTunTypeCNI HostnameRouteTunType = "cni"

TunnelID stringOptional

UUID of the tunnel.

formatuuid

maxLength36

TunnelName stringOptional

A user-friendly name for a tunnel.

Get hostname route

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"),
  )
  hostnameRoute, err := client.ZeroTrust.Networks.HostnameRoutes.Get(
    context.TODO(),
    "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    zero_trust.NetworkHostnameRouteGetParams{
      AccountID: cloudflare.F("699d98642c564d2e855e9661899b7252"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", hostnameRoute.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",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2009-11-10T23:00:00.000000Z",
    "hostname": "office-1.local",
    "tun_type": "cfd_tunnel",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "tunnel_name": "api-tunnel"
  },
  "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",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2009-11-10T23:00:00.000000Z",
    "hostname": "office-1.local",
    "tun_type": "cfd_tunnel",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "tunnel_name": "api-tunnel"
  },
  "success": true
}