Generate IPv4 address

GET 
/api/v1/networks/generate-ipv4

This API endpoint generates an IPv4 address within given IPSubnet of network if networkId provided else generate with default network's IPSubnet. This generated IPv4 address can be used while enabling networking API.

Request

Query Parameters

allParams objectrequired

allParams - networkId : the unique id of network

Responses

200

Success response

application/json

Schema

Schema

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

payload

object

Schema to get IPV4 address

ipv4Address string

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": {
    "ipv4Address": "string"
  }
}

Generate IPv4 address example

Generate IPv4 address response example

{
  "success": true,
  "message": "IPv4 Address generated successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": {
    "ipv4Address": "100.64.0.1"
  }
}

Loading...