Skip to main content
Query edge network instances
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

Query Parameters

deviceName
string
projectName
string
namePattern
string
tags
string
deviceNamePattern
string
projectNamePattern
string
summary
boolean
titlePattern
string

title pattern

next.pageToken
string

Page Token

next.orderBy
string[]

OrderBy helps in sorting the list response

next.pageNum
number<int64>

Page Number

next.pageSize
number<int64>

Defines the page size

next.totalPages
number<int64>

Total number of pages to be fetched.

fields
string[]

Response

A successful response.

list
Network instance summary configuration · object[]
cfgList
Network instance detailed configuration · object[]
summaryByKind
Summary is used to store the Summary details · object

Summary information about netinstance list records by network instance kind.

summaryByAddressType
Summary is used to store the Summary details · object

Summary information about netinstance list records by addressing type.

next
Cursor is used as filter in list operation. · object

Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.