Skip to main content
POST
/
registrar
/
v1
/
domains
/
{domain_name}
/
url-forwards
Create URL forward
curl --request POST \
  --url https://atom.com/api/registrar/v1/domains/{domain_name}/url-forwards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "https://www.example.com",
  "source": "www",
  "type": "permanent"
}
'
{
  "success": true,
  "message": "URL forward created successfully",
  "data": {
    "id": 456,
    "source": "www",
    "destination": "https://www.example.com",
    "type": "permanent"
  }
}

Authorizations

​
Authorization
string
header
required

Registrar API Bearer token. Obtain from dashboard at /dashboard/seller/api-access after requesting Registrar API access.

Path Parameters

​
domain_name
string
required

Domain name (e.g., 'example.com')

Body

application/json
​
destination
string
required

Full destination URL

Example:

"https://www.example.com"

​
source
string

Source subdomain (empty for root domain)

Example:

"www"

​
type
enum<string>
default:temporary

Redirect type: 'permanent' (301) or 'temporary' (302)

Available options:
permanent,
temporary
Example:

"permanent"

Response

URL forward created successfully

​
success
boolean
Example:

true

​
message
string
Example:

"URL forward created successfully"

​
data
object