config
Creates, updates, deletes, gets or lists a config resource.
Overview
| Name | config |
| Type | Resource |
| Id | vercel.domains.config |
Fields
The following fields are returned by SELECT queries:
- get_domain_config
| Name | Datatype | Description |
|---|---|---|
acceptedChallenges | array | Which challenge types the domain can use for issuing certs. |
configuredBy | string | How 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. |
misconfigured | boolean | Whether or not the domain is configured AND we can automatically generate a TLS certificate. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_domain_config | select | domain, teamId | Get 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.
| Name | Datatype | Description |
|---|---|---|
domain | string | The name of the domain. |
teamId | string | The Team identifier or slug to perform the request on behalf of. |
SELECT examples
- get_domain_config
Get a Domain's configuration.
SELECT
acceptedChallenges,
configuredBy,
misconfigured
FROM vercel.domains.config
WHERE domain = '{{ domain }}' -- required
AND teamId = '{{ teamId }}' -- required
;