Skip to main content
POST
/
environments
/
{environment}
/
domains
Create domain
curl --request POST \
  --url https://app.laravel.cloud/api/environments/{environment}/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "www_redirect": "root_to_www",
  "wildcard_enabled": true,
  "verification_method": "real_time"
}'
{
  "data": {
    "id": "<string>",
    "type": "domains",
    "attributes": {
      "name": "<string>",
      "type": "root",
      "hostname_status": "pending",
      "ssl_status": "pending",
      "origin_status": "pending",
      "redirect": "root_to_www",
      "dns_records": {
        "ssl": [
          {
            "type": "CNAME",
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "pre_verification": {
          "type": "TXT",
          "name": "<string>",
          "value": "<string>"
        },
        "origin": {
          "type": "A",
          "name": "<string>",
          "value": "<string>"
        }
      },
      "wildcard": {
        "hostname_status": "pending",
        "ssl_status": "pending",
        "origin_status": "pending",
        "dns_records": {
          "ssl": [
            {
              "type": "CNAME",
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "pre_verification": {
            "type": "TXT",
            "name": "<string>",
            "value": "<string>"
          },
          "origin": {
            "type": "A",
            "name": "<string>",
            "value": "<string>"
          }
        }
      },
      "www": {
        "hostname_status": "pending",
        "ssl_status": "pending",
        "origin_status": "pending",
        "dns_records": {
          "ssl": [
            {
              "type": "CNAME",
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "pre_verification": {
            "type": "TXT",
            "name": "<string>",
            "value": "<string>"
          },
          "origin": {
            "type": "A",
            "name": "<string>",
            "value": "<string>"
          }
        }
      },
      "last_verified_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "environment": {
        "data": {
          "type": "environments",
          "id": "<string>"
        }
      }
    },
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    }
  }
}

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
​
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

Response

DomainResource

​
data
object
required