Set default network

PUT 
/api/v1/networks/:networkId/set-default

This API endpoint set a network as the default for the specified network identified by the provided networkId. The default network will be used when no specific networkId is provided, for tasks such as enabling networking or generating IPv4 addresses

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 boolean

Example (from schema)

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

Set default network example

Set default network response example

{
  "success": true,
  "message": "Network set as default successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": true
}

Loading...