Fetch list of networks

GET 
/api/v1/networks

This API endpoint retrieve a paginated list of networks with detailed information for each network, including network attributes and configurations.

Request

Query Parameters

allParams objectrequired

allParams - pageNo, pageSize, sortBy, sortDirection, etc.

Responses

200

Success response

application/json

Schema

Schema

success boolean
message string
status string
statusCode int32
errorCode string
subErrors object[]

payload

object

Schema for paginated response

content

object[]

Array [

networkId string

provider string

ipSubnet string

dnsName string

dnsSuffix string

networkName string

isDefault boolean

isNetworkKeyManaged boolean

]

totalPages int32

totalRecordCount int64

pageSize int32

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": {
    "content": [
      {
        "networkId": "string",
        "provider": "string",
        "ipSubnet": "string",
        "dnsName": "string",
        "dnsSuffix": "string",
        "networkName": "string",
        "isDefault": true,
        "isNetworkKeyManaged": true
      }
    ],
    "totalPages": 0,
    "totalRecordCount": 0,
    "pageSize": 0
  }
}

Fetch networks list example

Fetch networks list response example

{
  "success": true,
  "message": "Networks fetched successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": {
    "content": [
      {
        "networkId": "xxb63e2aaedx-pffc-123",
        "provider": "provider",
        "ipSubnet": "10.0.0.0/24",
        "dnsName": "test-dns",
        "dnsSuffix": "mec.sh",
        "networkName": "test",
        "isDefault": true,
        "isNetworkKeyManaged": true
      }
    ],
    "totalPages": 2,
    "totalRecordCount": 2,
    "pageSize": 1
  }
}

Loading...