Skip to main content
PATCH
/
domains
/
{domain}
Update domain
curl --request PATCH \
  --url https://cloud.laravel.com/api/domains/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "verification_method": "real_time"
}
'
{
  "data": {
    "id": "<string>",
    "type": "domains",
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    },
    "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": "<unknown>",
            "value": "<unknown>"
          },
          "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": "<unknown>",
            "value": "<unknown>"
          },
          "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>"
        }
      }
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "environments",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "attributes": {
        "name": "<string>",
        "slug": "<string>",
        "status": "deploying",
        "created_from_automation": true,
        "vanity_domain": "<string>",
        "php_major_version": "8.2",
        "build_command": "<string>",
        "node_version": "20",
        "deploy_command": "<string>",
        "uses_octane": true,
        "uses_hibernation": true,
        "uses_push_to_deploy": true,
        "uses_deploy_hook": true,
        "environment_variables": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "network_settings": {
          "cache": {
            "strategy": "<string>"
          },
          "response_headers": {
            "frame": "<string>",
            "content_type": "<string>",
            "hsts": {
              "max_age": 123,
              "include_subdomains": true,
              "preload": true
            }
          },
          "firewall": {
            "bot_categories": [
              "academic_research"
            ],
            "rate_limit": {
              "429": true,
              "level": "challenge",
              "per_minute": 100,
              "4xx": true
            },
            "under_attack_mode_started_at": "<string>"
          }
        },
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "application": {
          "data": {
            "type": "applications",
            "id": "<string>"
          }
        },
        "branch": {
          "data": {
            "type": "branches",
            "id": "<string>"
          }
        },
        "deployments": {
          "data": [
            {
              "type": "deployments",
              "id": "<string>"
            }
          ]
        },
        "currentDeployment": {
          "data": {
            "type": "deployments",
            "id": "<string>"
          }
        },
        "domains": {
          "data": [
            {
              "type": "domains",
              "id": "<string>"
            }
          ]
        },
        "primaryDomain": {
          "data": {
            "type": "domains",
            "id": "<string>"
          }
        },
        "instances": {
          "data": [
            {
              "type": "instances",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

domain
string | null
required

The domain identifier

Body

application/json
verification_method
enum<string>
required

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[]