Generate a new domain

Generates a new domain name.

get

Generates a new domain name that is not in use by any brand. The domain name will be a random alphanumeric string and will be available in the system.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/brands/generate-domain

HTTPcURLJavaScriptPython

GET /api/v1/brands/generate-domain HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "rootDomain": "jframework.io",
    "subDomain": "dev-p0zhsi9",
    "fullDomain": "dev-p0zhsi9.jframework.io"
  },
  "errors": []
}