Traceroute.

POST

/api/operate/namespaces/{namespace}/sites/{site}/ver/traceroute

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/operate/namespaces/example/sites/example/ver/traceroute \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "dest": { "hostname": "example", "ip": "example" }, "hops": 1, "intf": { "any_intf": {}, "intf": "example" }, "namespace": "example", "node": "example", "retries": 1, "site": "example" }'

• F5 Distributed Cloud Console

Run traceroute to a destination.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace for which the request is sent (system)

site

required

string

Site Name Name of the site from which traceroute is initiated.

Request Body^required

Media typeapplication/json

Traceroute Request

Request to run traceroute to a destination.

object

dest

object

hostname

Hostname

Exclusive with [IP] DNS name of the host.

string

<= 256 characters

ip

IP

Exclusive with [hostname] IP address of the host.

string

<= 1024 characters

hops

Hops

Maximum number of hops (TTL) for probe packets.

integer format: int64

intf

object

any_intf

object

intf

Interface Name

Exclusive with [any_intf] Name of the chosen interface on the node.

string

>= 1 characters <= 256 characters

namespace

Namespace

Namespace for which the request is sent (system)

string

>= 6 characters <= 1024 characters

node

Node Name

Name of the node from which traceroute is initiated Required: YES.

string

>= 1 characters <= 64 characters

retries

Retries

Number of probes for each hop.

integer format: int64

site

Site Name

Name of the site from which traceroute is initiated.

string

<= 1024 characters

Example^generated

{
  "dest": {
    "hostname": "example",
    "ip": "example"
  },
  "hops": 1,
  "intf": {
    "any_intf": {},
    "intf": "example"
  },
  "namespace": "example",
  "node": "example",
  "retries": 1,
  "site": "example"
}

Responses

200

A successful response.

Media typeapplication/json

Traceroute Response

Response to Traceroute request.

object

hops

Hops

All the hops in traceroute response.

Array<object>

Hop

Hop info for each Traceroute response.

object

addr

Address

Address of the hop.

string

<= 1024 characters

elapsed_time_ms

Elapsed Time

Time taken to receive traceroute response (milli seconds)

integer format: int64

host

Host

Host name of the hop, if available.

string

<= 1024 characters

ttl

TTL

TTL of the hop.

integer format: int64

Example^generated

{
  "hops": [
    {
      "addr": "example",
      "elapsed_time_ms": 1,
      "host": "example",
      "ttl": 1
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example