Skip to main content

config

Creates, updates, deletes, gets or lists a config resource.

Overview

Nameconfig
TypeResource
Idvercel.domains.config

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
acceptedChallengesarrayWhich challenge types the domain can use for issuing certs.
configuredBystringHow we see the domain's configuration. - CNAME: Domain has a CNAME pointing to Vercel. - A: Domain's A record is resolving to Vercel. - http: Domain is resolving to Vercel but may be behind a Proxy. - null: Domain is not resolving to Vercel.
misconfiguredbooleanWhether or not the domain is configured AND we can automatically generate a TLS certificate.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_domain_configselectdomain, teamIdGet a Domain's configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
domainstringThe name of the domain.
teamIdstringThe Team identifier or slug to perform the request on behalf of.

SELECT examples

Get a Domain's configuration.

SELECT
acceptedChallenges,
configuredBy,
misconfigured
FROM vercel.domains.config
WHERE domain = '{{ domain }}' -- required
AND teamId = '{{ teamId }}' -- required
;