Skip to main content
POST
/
environments
/
{environment}
/
domains
Create domain
curl --request POST \
  --url https://cloud.laravel.com/api/environments/{environment}/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "www_redirect": "root_to_www",
  "wildcard_enabled": false,
  "allow_downtime": true,
  "cloudflare_strategy": "none",
  "verification_method": "real_time"
}
'
{
  "data": {
    "id": "<string>",
    "type": "domains",
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    },
    "relationships": {}
  },
  "included": [
    {
      "id": "<string>",
      "type": "environments",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "relationships": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

​
environment
string
required

The environment identifier

Body

application/json
​
name
string
required
Required string length: 3 - 255
​
www_redirect
enum<string>
Available options:
root_to_www,
www_to_root
​
wildcard_enabled
boolean | null

Whether to enable a wildcard subdomain (*.example.com) for this domain.

Example:

false

​
allow_downtime
boolean | null

Whether to allow downtime during domain verification. When true (flexible), the domain can be pointed directly without pre-verification. When false (uninterrupted), TXT-based pre-verification is required to avoid downtime.

Example:

true

​
cloudflare_strategy
enum<string>

The Cloudflare integration strategy. "none" uses A records with no Cloudflare integration. "dns" uses CNAME records via Cloudflare DNS only. "dns_proxy" uses CNAME records with Cloudflare's proxy enabled (Orange cloud).

Available options:
dns_proxy,
dns,
none
Example:

"none"

​
verification_method
enum<string>

The domain verification method to use. Pre-verification allows domain verification via TXT record before the domain is pointed to the environment. Real-time verification requires the domain to already be pointing to the environment.

Available options:
pre_verification,
real_time
Example:

"real_time"

Response

DomainResource

​
data
DomainResource · object
required
​
included
EnvironmentResource · object[]