Delete network

DELETE 
/api/v1/networks/:networkId

This API endpoint removes a network identified by the provided networkId, provided it is not the default network and does not contain any nodes. Once network node is deleted, it cannot be retrieved.

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
}

Delete network example

Delete network response example

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

Loading...