Vercel/domains
@swamp/vercel/domainsv2026.10.23.1
01README
Vercel domains infrastructure models
02Release Notes
- Updated: domains
03Behaviors
@swamp/vercel/domains/domainsv2026.10.23.1domains.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| teamId? | string | Vercel team ID |
| slug? | string | Vercel team slug (alternative to teamId) |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| op? | string | |
| renew? | boolean | This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/auto-renew instead. |
| customNameservers? | array | This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/nameservers instead. |
| zone? | boolean | Specifies whether this is a DNS zone that intends to use Vercel's nameservers. |
| echMode? | enum | Encrypted Client Hello enrollment. 'auto' leaves it to Vercel, 'disabled' never enrolls and opts out of automatic enrollment. |
| destination? | string | User or team to move domain to |
| method? | string | The domain operation to perform. It can be either `add` or `move-in`. |
| token? | string | Vercel API token; overrides the VERCEL_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
fn create()
Create a Domains
fn get(id: string)
Get a Domains
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Domains |
fn lookup(allowMissing?: boolean)
Look up an existing Domains by matching global argument values and import it into state
| Argument | Type | Description |
|---|---|---|
| allowMissing? | boolean | Succeed and record found: false in lookupResult when nothing matches, instead of failing |
fn adopt(id: string)
Import an existing Domains by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Domains to import |
fn update(identifier?: string)
Update Domains attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Domains by name (e.g. one discovered by list) |
fn delete(id: string)
Delete the Domains
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Domains |
fn sync(identifier?: string)
Sync Domains state from Vercel
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Domains by name (e.g. one discovered by list) |
Resources
state(infinite)— Domains resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions
2026.10.20.1AGPL-3.0-or-later(was none)
- Updated: domains
Modified 1 behaviors
2026.10.13.1
- Updated: domains
2026.10.02.1
- Updated: domains
2026.09.16.1
- Updated: domains
2026.08.28.1
- Updated: domains
2026.08.26.1
- Updated: domains
2026.08.03.2
- Updated: domains
05Stats
A
100 / 100
Downloads
26
Archive size
10.4 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels