Check DNS name in use for network nodes

GET 
/api/v1/networks/nodes/check-dns-name-inuse

This API endpoint checks if a DNS name is available or already in use within a network nodes for the specified network identified by the provided networkId.

Request

Query Parameters

dnsName stringrequired

The dnsName - Network node DNS name

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 string

Example (from schema)

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

Check DNS name in use example

Check DNS name in use response example

{
  "success": true,
  "message": "DNS name available for further processing",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": null
}

Loading...