Domains

Update a domain's origin or routing options.

Only the fields you send change. The hostname itself is immutable.

patch/v1/domains/{id}

Request

  • Base URL: https://api.domainee.dev
  • URL: https://api.domainee.dev/v1/domains/{id}
  • Auth: HTTP bearer

Request body

originUrlstring uri
metadataobject
mode'proxy' | 'redirect'
keepHostboolean
redirectWwwboolean
redirectStatus301 | 302

Response

The domain.

Example response

{
  "domain": {
    "id": "dom_9f2c",
    "hostname": "app.acme.com",
    "originUrl": "https://acme.vercel.app",
    "dnsRecords": [
      {
        "name": "app.acme.com",
        "value": "edge.domainee.dev",
        "type": "CNAME",
        "purpose": "Traffic Routing"
      }
    ],
    "dnsRecordOptions": [
      {
        "label": "A records",
        "records": [
          {
            "name": "app.acme.com",
            "value": "edge.domainee.dev",
            "type": "CNAME",
            "purpose": "Traffic Routing"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.