Get edge network instance (GET /v1/netinsts/id/{id})

Get edge network instance

curl --request GET \
  --url https://{apiHost}/api/v1/netinsts/id/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/netinsts/id/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "<string>",
  "title": "<string>",
  "deviceId": "<string>",
  "port": "<string>",
  "kind": "NETWORK_INSTANCE_KIND_UNSPECIFIED",
  "id": "<string>",
  "description": "<string>",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "projectId": "<string>",
  "tags": {},
  "clusterID": "<string>",
  "portTags": {},
  "dhcp": true,
  "type": "NETWORK_INSTANCE_DHCP_TYPE_UNSPECIFIED",
  "ip": {
    "subnet": "<string>",
    "mask": "<string>",
    "gateway": "<string>",
    "domain": "<string>",
    "ntp": "<string>",
    "dns": [
      "<string>"
    ],
    "dhcpRange": {
      "start": "<string>",
      "end": "<string>"
    },
    "ntpServers": [
      {
        "server": "<string>"
      }
    ]
  },
  "dnsList": [
    {
      "hostname": "<string>",
      "addrs": [
        "<string>"
      ]
    }
  ],
  "oconfig": "<string>",
  "lisp": {
    "lispiid": 123,
    "allocate": true,
    "exportprivate": true,
    "allocationprefix": "aSDinaTvuI8gbWludGxpZnk=",
    "allocationprefixlen": 123,
    "sp": [
      {
        "type": "SPTYPE_INVALIDSRV",
        "NameOrIp": "<string>",
        "Credential": "<string>"
      }
    ]
  },
  "opaque": {
    "type": "OPAQUE_CONFIG_TYPE_UNSPECIFIED",
    "oconfig": "<string>",
    "lisp": {
      "lispiid": 123,
      "allocate": true,
      "exportprivate": true,
      "allocationprefix": "aSDinaTvuI8gbWludGxpZnk=",
      "allocationprefixlen": 123,
      "sp": [
        {
          "type": "SPTYPE_INVALIDSRV",
          "NameOrIp": "<string>",
          "Credential": "<string>"
        }
      ]
    }
  },
  "deviceDefault": true,
  "networkPolicyId": "<string>",
  "propagateConnectedRoutes": true,
  "staticRoutes": [
    {
      "prefix": "<string>",
      "gateway": "<string>",
      "outputPort": "<string>",
      "probeConfig": {
        "enableGatewayPing": true,
        "pingMaxCost": 123,
        "preferLowerCost": true,
        "preferStrongerWwanSignal": true,
        "customProbeConfig": {
          "probeMethod": "CONNECTIVITY_PROBE_METHOD_UNSPECIFIED",
          "probeEndpoint": {
            "host": "<string>",
            "port": 123
          }
        }
      }
    }
  ],
  "mtu": 123,
  "edgeNodeCluster": {
    "id": "<string>",
    "designatedNodeID": "<string>"
  },
  "forwardLldp": true
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authentication · API availability · Download OpenAPI

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Path Parameters

string

required

System defined universally unique Id of the network instance

Response

A successful response.

Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge applications within a single Edge node and within a logical group of Edge nodes. This provides detailed configuration of a Network instance.

name

string

required

User defined name of the network instance, unique across the enterprise. Once object is created, name can’t be changed

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

title

string

required

User defined title of the network instance. Title can be changed at any time

Required string length: 3 - 256

Pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+$

deviceId

string

required

id of the device on which network instance is created

port

string

required

name of port mapping in the model

kind

enum<string>

default:NETWORK_INSTANCE_KIND_UNSPECIFIED

required

Kind of Network Instance ( Local, Switch etc )

Available options:

NETWORK_INSTANCE_KIND_UNSPECIFIED,

NETWORK_INSTANCE_KIND_TRANSPARENT,

NETWORK_INSTANCE_KIND_SWITCH,

NETWORK_INSTANCE_KIND_LOCAL,

NETWORK_INSTANCE_KIND_CLOUD,

NETWORK_INSTANCE_KIND_MESH,

NETWORK_INSTANCE_KIND_HONEYPOT

string

read-only

System defined universally unique Id of the network instance

Pattern: [0-9A-Za-z-]+

description

string

Detailed description of the network instance

Maximum string length: 256

revision

ObjectRevision is used to store the user information. · object

system defined info for the object

Show child attributes

projectId

string

id of the project in which network instance is created

tags

object

Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3.

Show child attributes

clusterID

string

id of the Cluster in which the network instance is configured

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

portTags

object

Show child attributes

dhcp

boolean

Deprecated

type

enum<string>

default:NETWORK_INSTANCE_DHCP_TYPE_UNSPECIFIED

Type of DHCP for this Network Instance

Available options:

NETWORK_INSTANCE_DHCP_TYPE_UNSPECIFIED,

NETWORK_INSTANCE_DHCP_TYPE_V4,

NETWORK_INSTANCE_DHCP_TYPE_V6,

NETWORK_INSTANCE_DHCP_TYPE_CRYPTOEID,

NETWORK_INSTANCE_DHCP_TYPE_CRYPTOV4,

NETWORK_INSTANCE_DHCP_TYPE_CRYPTOV6

object

Dhcp Server Configuration

Show child attributes

dnsList

Static DNS list · object[]

List of Static DNS entries

Show child attributes

oconfig

string

lisp

Lisp Configurations · object

Lisp Config : read only for now. Deprecated.

Show child attributes

opaque

object

Service specific Config

Show child attributes

deviceDefault

boolean

flag to indicate if this is the default network instance for the device

networkPolicyId

string

id of the network policy to be attached to this network instance

propagateConnectedRoutes

boolean

Automatically propagate connected routes

staticRoutes

Static IP Routes · object[]

List of Static IP routes

Show child attributes

mtu

integer<int64>

Maximum transmission unit (MTU) to set for the network instance and all application interfaces connected to it

edgeNodeCluster

object

Edge Node Cluster

Show child attributes

forwardLldp

boolean

Enables forwarding of LLDP (Link Layer Discovery Protocol) frames across this network instance. LLDP is used by devices to advertise identity and capabilities to directly connected neighbors, and is often required for topology discovery and network management tools. When enabled, LLDP frames (EtherType 0x88cc) are not dropped or suppressed by the forwarding plane.

⌘I

Get edge network instance

curl --request GET \
  --url https://{apiHost}/api/v1/netinsts/id/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/netinsts/id/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "<string>",
  "title": "<string>",
  "deviceId": "<string>",
  "port": "<string>",
  "kind": "NETWORK_INSTANCE_KIND_UNSPECIFIED",
  "id": "<string>",
  "description": "<string>",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "projectId": "<string>",
  "tags": {},
  "clusterID": "<string>",
  "portTags": {},
  "dhcp": true,
  "type": "NETWORK_INSTANCE_DHCP_TYPE_UNSPECIFIED",
  "ip": {
    "subnet": "<string>",
    "mask": "<string>",
    "gateway": "<string>",
    "domain": "<string>",
    "ntp": "<string>",
    "dns": [
      "<string>"
    ],
    "dhcpRange": {
      "start": "<string>",
      "end": "<string>"
    },
    "ntpServers": [
      {
        "server": "<string>"
      }
    ]
  },
  "dnsList": [
    {
      "hostname": "<string>",
      "addrs": [
        "<string>"
      ]
    }
  ],
  "oconfig": "<string>",
  "lisp": {
    "lispiid": 123,
    "allocate": true,
    "exportprivate": true,
    "allocationprefix": "aSDinaTvuI8gbWludGxpZnk=",
    "allocationprefixlen": 123,
    "sp": [
      {
        "type": "SPTYPE_INVALIDSRV",
        "NameOrIp": "<string>",
        "Credential": "<string>"
      }
    ]
  },
  "opaque": {
    "type": "OPAQUE_CONFIG_TYPE_UNSPECIFIED",
    "oconfig": "<string>",
    "lisp": {
      "lispiid": 123,
      "allocate": true,
      "exportprivate": true,
      "allocationprefix": "aSDinaTvuI8gbWludGxpZnk=",
      "allocationprefixlen": 123,
      "sp": [
        {
          "type": "SPTYPE_INVALIDSRV",
          "NameOrIp": "<string>",
          "Credential": "<string>"
        }
      ]
    }
  },
  "deviceDefault": true,
  "networkPolicyId": "<string>",
  "propagateConnectedRoutes": true,
  "staticRoutes": [
    {
      "prefix": "<string>",
      "gateway": "<string>",
      "outputPort": "<string>",
      "probeConfig": {
        "enableGatewayPing": true,
        "pingMaxCost": 123,
        "preferLowerCost": true,
        "preferStrongerWwanSignal": true,
        "customProbeConfig": {
          "probeMethod": "CONNECTIVITY_PROBE_METHOD_UNSPECIFIED",
          "probeEndpoint": {
            "host": "<string>",
            "port": 123
          }
        }
      }
    }
  ],
  "mtu": 123,
  "edgeNodeCluster": {
    "id": "<string>",
    "designatedNodeID": "<string>"
  },
  "forwardLldp": true
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

API guides

API services

Get edge network instance (GET /v1/netinsts/id/{id})

Authorizations

Headers

Path Parameters

Response