Network Check
The network-check endpoint allows you to verify whether a desired network name is available for registration.
POST /auth/network-check
Checks if a specific network name can be assigned to a new network.
Request
POST /auth/network-check
Headers:
{
"Host": "api.bringyour.com",
"Content-Type": "application/json"
}Body:
{
"network_name": "string"
}| Field | Type | Description |
|---|---|---|
network_name | string | Required. The desired name for the new network. |
Response
200 Success
Status: 200 OK
Content-Type: application/json
A successful response indicates whether the provided name is available.
{
"available": true
}| Field | Type | Description |
|---|---|---|
available | boolean | true if the name is available, false otherwise. |
Example
HTTP Request
POST /auth/network-check HTTP/1.1
Host: api.bringyour.com
Content-Type: application/json
{
"network_name": "alpha-omega"
}Successful HTTP Response
{
"available": true
}