Skip to main content
Server path: /vercel-domains | Type: Application | PCID required: Yes

Tools

ToolDescription
vercel_domains_buy_domainsBuy multiple domains
vercel_domains_buy_single_domainBuy a domain
vercel_domains_create_or_transfer_domainAdd an existing domain to the Vercel platform
vercel_domains_create_recordCreate a DNS record
vercel_domains_delete_domainRemove a domain by name
vercel_domains_get_bulk_availabilityGet availability for multiple domains
vercel_domains_get_cert_by_idGet cert by id
vercel_domains_get_contact_info_schemaGet contact info schema
vercel_domains_get_domainGet Information for a Single Domain
vercel_domains_get_domain_auth_codeGet the auth code for a domain
vercel_domains_get_domain_availabilityGet availability for a domain
vercel_domains_get_domain_configGet a Domain’s configuration
vercel_domains_get_domain_priceGet price data for a domain
vercel_domains_get_domain_transfer_inGet a domain’s transfer status
vercel_domains_get_domainsList all the domains
vercel_domains_get_orderGet a domain order
vercel_domains_get_recordsList existing DNS records
vercel_domains_get_supported_tldsGet supported TLDs
vercel_domains_get_tldGet TLD
vercel_domains_get_tld_priceGet TLD price data
vercel_domains_issue_certIssue a new cert
vercel_domains_patch_domainUpdate or move apex domain
vercel_domains_remove_certRemove cert
vercel_domains_remove_recordDelete a DNS record
vercel_domains_renew_domainRenew a domain
vercel_domains_transfer_in_domainTransfer-in a domain
vercel_domains_update_domain_auto_renewUpdate auto-renew for a domain
vercel_domains_update_domain_nameserversUpdate nameservers for a domain
vercel_domains_update_recordUpdate an existing DNS record
vercel_domains_upload_certUpload a cert

vercel_domains_buy_domains

Buy multiple domains Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringNoTeam Id
contactInformationobjectYesThe contact information for the domain. Some TLDs require additional contact information. Use the Get contact info schema endpoint to retrieve the required fields.
domainsany[]YesThe domains value

vercel_domains_buy_single_domain

Buy a domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesA valid domain name
teamIdstringNoTeam Id
autoRenewbooleanYesWhether the domain should be auto-renewed before it expires. This can be configured later through the Vercel Dashboard or the Update auto-renew for a domain endpoint.
contactInformationobjectYesThe contact information for the domain. Some TLDs require additional contact information. Use the Get contact info schema endpoint to retrieve the required fields.
expectedPricenumberYesExpected Price
languageCodestringNoThe language code for the domain. For punycode domains, this must be provided. The list of supported language codes for a TLD can be retrieved from the Get TLD endpoint.
yearsnumberYesThe number of years to purchase the domain for.

vercel_domains_create_or_transfer_domain

Add an existing domain to the Vercel platform Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
bodyobjectNoRequest body

vercel_domains_create_record

Create a DNS record Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesThe domain used to create the DNS record.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
bodyobjectYesRequest body

vercel_domains_delete_domain

Remove a domain by name Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesThe name of the domain.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_domains_get_bulk_availability

Get availability for multiple domains Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringNoTeam Id
domainsany[]Yesan array of at most 50 item(s)

vercel_domains_get_cert_by_id

Get cert by id Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe cert id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_domains_get_contact_info_schema

Get contact info schema Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesA valid domain name
teamIdstringNoTeam Id

vercel_domains_get_domain

Get Information for a Single Domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesThe name of the domain.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_domains_get_domain_auth_code

Get the auth code for a domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesA valid domain name
teamIdstringNoTeam Id

vercel_domains_get_domain_availability

Get availability for a domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesA valid domain name
teamIdstringNoTeam Id

vercel_domains_get_domain_config

Get a Domain’s configuration Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesThe name of the domain.
projectIdOrNamestringNoThe project id or name that will be associated with the domain. Use this when the domain is not yet associated with a project.
strictobjectNoWhen true, the response will only include the nameservers assigned directly to the specified domain. When false and there are no nameservers assigned directly to the specified domain, the response will include the nameservers of the domain’s parent zone.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_domains_get_domain_price

Get price data for a domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesA valid domain name
yearsstringNoThe number of years to get the price for. If not provided, the minimum number of years for the TLD will be used.
teamIdstringNoTeam Id

vercel_domains_get_domain_transfer_in

Get a domain’s transfer status Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesA valid domain name
teamIdstringNoTeam Id

vercel_domains_get_domains

List all the domains Parameters:
ParameterTypeRequiredDefaultDescription
limitnumberNoMaximum number of domains to list from a request.
sincenumberNoGet domains created after this JavaScript timestamp.
untilnumberNoGet domains created before this JavaScript timestamp.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_domains_get_order

Get a domain order Parameters:
ParameterTypeRequiredDefaultDescription
orderIdstringYesA valid order ID
teamIdstringNoTeam Id

vercel_domains_get_records

List existing DNS records Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesThe domain value
limitstringNoMaximum number of records to list from a request.
sincestringNoGet records created after this JavaScript timestamp.
untilstringNoGet records created before this JavaScript timestamp.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_domains_get_supported_tlds

Get supported TLDs Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringNoTeam Id

vercel_domains_get_tld

Get TLD Parameters:
ParameterTypeRequiredDefaultDescription
tldstringYesA valid TLD name
teamIdstringNoTeam Id

vercel_domains_get_tld_price

Get TLD price data Parameters:
ParameterTypeRequiredDefaultDescription
tldstringYesA valid TLD name
yearsstringNoThe number of years to get the price for. If not provided, the minimum number of years for the TLD will be used.
teamIdstringNoTeam Id

vercel_domains_issue_cert

Issue a new cert Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
cnsany[]NoThe common names the cert should be issued for

vercel_domains_patch_domain

Update or move apex domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesThe domain value
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
bodyobjectYesRequest body

vercel_domains_remove_cert

Remove cert Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe cert id to remove
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_domains_remove_record

Delete a DNS record Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesThe domain value
recordIdstringYesRecord Id
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_domains_renew_domain

Renew a domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesA valid domain name
teamIdstringNoTeam Id
contactInformationobjectNoContact Information
expectedPricenumberYesExpected Price
yearsnumberYesThe number of years to renew the domain for.

vercel_domains_transfer_in_domain

Transfer-in a domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesA valid domain name
teamIdstringNoTeam Id
authCodestringYesThe auth code for the domain. You must obtain this code from the losing registrar.
autoRenewbooleanYesWhether the domain should be auto-renewed before it expires. This can be configured later through the Vercel Dashboard or the Update auto-renew for a domain endpoint.
contactInformationobjectYesContact Information
expectedPricenumberYesExpected Price
yearsnumberYesThe number of years to renew the domain for once it is transferred in. This must be a valid number of transfer years for the TLD.

vercel_domains_update_domain_auto_renew

Update auto-renew for a domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesA valid domain name
teamIdstringNoTeam Id
autoRenewbooleanYesAuto Renew

vercel_domains_update_domain_nameservers

Update nameservers for a domain Parameters:
ParameterTypeRequiredDefaultDescription
domainstringYesA valid domain name
teamIdstringNoTeam Id
nameserversany[]YesThe nameservers value

vercel_domains_update_record

Update an existing DNS record Parameters:
ParameterTypeRequiredDefaultDescription
recordIdstringYesThe id of the DNS record
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
commentstringNoA comment to add context on what this DNS record is for
httpsobjectNoThe https value
mxPriorityintegerNoThe MX priority value of the DNS record
namestringNoThe name of the DNS record
srvobjectNoThe srv value
ttlintegerNoThe Time to live (TTL) value of the DNS record
typestringNoThe type of the DNS record
valuestringNoThe value of the DNS record

vercel_domains_upload_cert

Upload a cert Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
castringYesThe certificate authority
certstringYesThe certificate
keystringYesThe certificate key
skipValidationbooleanNoSkip validation of the certificate