Fetch network details

GET 
/api/v1/networks/:networkId

This API endpoint retrieve details of a network identified by the provided networkId, including network attributes and configurations.

Request

Path Parameters

networkId stringrequired

The networkId - unique id of the network

Responses

200

Success response

application/json

Schema

Schema

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

payload

object

Networks schema

networkId string

provider string

ipSubnet string

dnsName string

dnsSuffix string

networkName string

isDefault boolean

isNetworkKeyManaged boolean

Example (from schema)

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

Network details example

Network details response example

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

Loading...