Get edge network (GET /v1/networks/name/{name})

Get edge network

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

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

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

{
  "name": "<string>",
  "title": "<string>",
  "projectId": "<string>",
  "kind": "NETWORK_KIND_UNSPECIFIED",
  "ip": {
    "deprecatedDhcp": true,
    "dhcp": "NETWORK_DHCP_TYPE_UNSPECIFIED",
    "subnet": "<string>",
    "mask": "<string>",
    "gateway": "<string>",
    "domain": "<string>",
    "ntp": "<string>",
    "dns": [
      "<string>"
    ],
    "dhcpRange": {
      "start": "<string>",
      "end": "<string>"
    },
    "ntpServers": [
      {
        "server": "<string>"
      }
    ],
    "ntpServerExclusively": true
  },
  "id": "<string>",
  "description": "<string>",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "dnsList": [
    {
      "hostname": "<string>",
      "addrs": [
        "<string>"
      ]
    }
  ],
  "proxy": {
    "networkProxy": true,
    "proxies": [
      {
        "proto": "NETWORK_PROXY_PROTO_HTTP",
        "server": "<string>",
        "port": 123
      }
    ],
    "exceptions": "<string>",
    "pacfile": "<string>",
    "networkProxyURL": "<string>",
    "networkProxyCerts": [
      "aSDinaTvuI8gbWludGxpZnk="
    ]
  },
  "enterpriseDefault": true,
  "mtu": 123,
  "wireless": {
    "type": "NETWORK_WIRELESS_TYPE_UNSPECIFIED",
    "cellularCfg": {
      "APN": "<string>",
      "probe": {
        "disable": true,
        "probeAddress": "<string>",
        "customProbe": {
          "probeMethod": "CONNECTIVITY_PROBE_METHOD_UNSPECIFIED",
          "probeEndpoint": {
            "host": "<string>",
            "port": 123
          }
        }
      },
      "locationTracking": true,
      "accessPoints": [
        {
          "simSlot": 123,
          "apn": "<string>",
          "authProtocol": "CELLULAR_AUTH_PROTOCOL_NONE",
          "cipherData": {
            "cipherContextId": "<string>",
            "initialValue": "aSDinaTvuI8gbWludGxpZnk=",
            "cipherData": "aSDinaTvuI8gbWludGxpZnk=",
            "clearTextSha256": "aSDinaTvuI8gbWludGxpZnk="
          },
          "preferredPlmns": [
            "<string>"
          ],
          "forbidRoaming": true,
          "preferredRats": [
            "RADIO_ACCESS_TECHNOLOGY_UNSPECIFIED"
          ],
          "ipType": "CELLULAR_IP_TYPE_UNSPECIFIED",
          "attachApn": "<string>",
          "attachIpType": "CELLULAR_IP_TYPE_UNSPECIFIED",
          "attachAuthProtocol": "CELLULAR_AUTH_PROTOCOL_NONE",
          "secrets": {
            "username": "<string>",
            "password": "<string>"
          },
          "encryptedSecrets": {},
          "cryptoKey": "<string>",
          "attachSecrets": {
            "username": "<string>",
            "password": "<string>"
          },
          "attachEncryptedSecrets": {}
        }
      ],
      "activatedSimSlot": 123
    },
    "wifiCfg": {
      "wifiSSID": "<string>",
      "keyScheme": "NETWORK_WIFIKEY_SCHEME_UNSPECIFIED",
      "identity": "<string>",
      "secret": {
        "WiFiPasswd": "<string>"
      },
      "crypto": {
        "identity": "<string>",
        "password": "<string>"
      },
      "priority": 123,
      "encryptedSecrets": {},
      "cryptoKey": "<string>"
    }
  },
  "project": {
    "projectId": "<string>",
    "projectName": "<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>"
    }
  ]
}

{
  "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

name

string

required

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

Response

A successful response.

Network provides Edge nodes a variety of connectivity choices for all types of networks. This enables physical connectivity with Ethernet, WiFi, LTE to communicate with ZEDEDA Cloud controller and Data Centres.

name

string

required

User defined name of the network, 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. Title can be changed at any time

Required string length: 3 - 256

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

projectId

string

required

kind

enum<string>

default:NETWORK_KIND_UNSPECIFIED

required

Available options:

NETWORK_KIND_UNSPECIFIED,

NETWORK_KIND_V4,

NETWORK_KIND_V6,

NETWORK_KIND_V4_ONLY,

NETWORK_KIND_V6_ONLY,

NETWORK_KIND_DUAL_V4_V6

object

required

Show child attributes

string

read-only

System defined universally unique Id of the network

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

description

string

Detailed description of the network

Maximum string length: 256

revision

ObjectRevision is used to store the user information. · object

system defined info

Show child attributes

dnsList

Static DNS list · object[]

Show child attributes

proxy

enterprise proxy · object

Net Proxy Configurations

Show child attributes

enterpriseDefault

boolean

mtu

integer<int64>

wireless

Wifi configuration · object

Show child attributes

project

project configuration · object

Show child attributes

⌘I

Get edge network

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

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

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

{
  "name": "<string>",
  "title": "<string>",
  "projectId": "<string>",
  "kind": "NETWORK_KIND_UNSPECIFIED",
  "ip": {
    "deprecatedDhcp": true,
    "dhcp": "NETWORK_DHCP_TYPE_UNSPECIFIED",
    "subnet": "<string>",
    "mask": "<string>",
    "gateway": "<string>",
    "domain": "<string>",
    "ntp": "<string>",
    "dns": [
      "<string>"
    ],
    "dhcpRange": {
      "start": "<string>",
      "end": "<string>"
    },
    "ntpServers": [
      {
        "server": "<string>"
      }
    ],
    "ntpServerExclusively": true
  },
  "id": "<string>",
  "description": "<string>",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "dnsList": [
    {
      "hostname": "<string>",
      "addrs": [
        "<string>"
      ]
    }
  ],
  "proxy": {
    "networkProxy": true,
    "proxies": [
      {
        "proto": "NETWORK_PROXY_PROTO_HTTP",
        "server": "<string>",
        "port": 123
      }
    ],
    "exceptions": "<string>",
    "pacfile": "<string>",
    "networkProxyURL": "<string>",
    "networkProxyCerts": [
      "aSDinaTvuI8gbWludGxpZnk="
    ]
  },
  "enterpriseDefault": true,
  "mtu": 123,
  "wireless": {
    "type": "NETWORK_WIRELESS_TYPE_UNSPECIFIED",
    "cellularCfg": {
      "APN": "<string>",
      "probe": {
        "disable": true,
        "probeAddress": "<string>",
        "customProbe": {
          "probeMethod": "CONNECTIVITY_PROBE_METHOD_UNSPECIFIED",
          "probeEndpoint": {
            "host": "<string>",
            "port": 123
          }
        }
      },
      "locationTracking": true,
      "accessPoints": [
        {
          "simSlot": 123,
          "apn": "<string>",
          "authProtocol": "CELLULAR_AUTH_PROTOCOL_NONE",
          "cipherData": {
            "cipherContextId": "<string>",
            "initialValue": "aSDinaTvuI8gbWludGxpZnk=",
            "cipherData": "aSDinaTvuI8gbWludGxpZnk=",
            "clearTextSha256": "aSDinaTvuI8gbWludGxpZnk="
          },
          "preferredPlmns": [
            "<string>"
          ],
          "forbidRoaming": true,
          "preferredRats": [
            "RADIO_ACCESS_TECHNOLOGY_UNSPECIFIED"
          ],
          "ipType": "CELLULAR_IP_TYPE_UNSPECIFIED",
          "attachApn": "<string>",
          "attachIpType": "CELLULAR_IP_TYPE_UNSPECIFIED",
          "attachAuthProtocol": "CELLULAR_AUTH_PROTOCOL_NONE",
          "secrets": {
            "username": "<string>",
            "password": "<string>"
          },
          "encryptedSecrets": {},
          "cryptoKey": "<string>",
          "attachSecrets": {
            "username": "<string>",
            "password": "<string>"
          },
          "attachEncryptedSecrets": {}
        }
      ],
      "activatedSimSlot": 123
    },
    "wifiCfg": {
      "wifiSSID": "<string>",
      "keyScheme": "NETWORK_WIFIKEY_SCHEME_UNSPECIFIED",
      "identity": "<string>",
      "secret": {
        "WiFiPasswd": "<string>"
      },
      "crypto": {
        "identity": "<string>",
        "password": "<string>"
      },
      "priority": 123,
      "encryptedSecrets": {},
      "cryptoKey": "<string>"
    }
  },
  "project": {
    "projectId": "<string>",
    "projectName": "<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>"
    }
  ]
}

{
  "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 (GET /v1/networks/name/{name})

Authorizations

Headers

Path Parameters

Response