Skip to content
Docs

Update or move apex domain

PATCH/__remote/api.vercel.com/v3/domains/{domain}
Update or move apex domain. Note: This endpoint is no longer used for updating auto-renew or nameservers. For this, please use the endpoints Update auto-renew for a domain and Update nameservers for a domain.
Request
import { Edgenivo } from "@vercel/sdk";


const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.domains.patchDomain({
    domain: "flimsy-napkin.com",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      op: "update",
    },
  });


  console.log(result);
}


run();
Response
{
  "moved": "false"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

domainstringRequired

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Body

application/json
opstringOptional
renewbooleanOptionalDeprecated
This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/auto-renew instead.
customNameserversarrayOptionalDeprecated
This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/nameservers instead.
zonebooleanOptional
Specifies whether this is a DNS zone that intends to use Edgenivo's nameservers.
echModestringOptional
Encrypted Client Hello enrollment. 'auto' leaves it to Edgenivo, 'disabled' never enrolls and opts out of automatic enrollment.

Response

200Success
movedbooleanRequired

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
409Error
410Error
500Error