Cloudflare/registrar
@swamp/cloudflare/registrarv2026.09.01.1
01README
Cloudflare registrar infrastructure models
02Release Notes
- Updated: registrations
03Models
@swamp/cloudflare/registrar/registrationsv2026.09.01.1registrations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auto_renew? | boolean | Enable or disable automatic renewal. Defaults to `false` if omitted.\nSetting this field to `true` is an explicit opt-in authorizing\nCloudflare to charge the account's default payment method up to 30\ndays before domain expiry to renew the domain automatically.\nRenewal pricing may change over time based on registry pricing.\n |
| acknowledgements? | record | Provides user acknowledgements for a specific extension or premium\nregistration flow. The extension registration schema from the\nextension discovery endpoint identifies the required keys.\n |
| contact_extensions? | record | Provides registry-specific contact extension values for the registrant.\n`GET /accounts/{account_id}/registrar/extensions/{extension}` identifies\nthe required keys and allowed values for each extension in the\n`registration_schema.properties.contact_extensions` object.\n\nExamples include `.us` nexus fields, `.uk` registrant type fields,\nand `.ca` legal type fields. Omit this object when the extension's\nregistration schema excludes `contact_extensions`.\n |
| contacts? | object | Provides contact data for the registration request.\n\nThe per-extension schema from\n`GET /accounts/{account_id}/registrar/extensions/{extension}` defines the\naccepted contact roles. Every currently supported extension requires only\n`contacts.registrant` from API callers. Callers may provide additional roles\nsuch as `technical`, `administrator`, and `billing` when the extension\nschema includes them. When a registry requires an omitted role, Cloudflare\nmay derive that contact from `contacts |
| domain_name | string | Provides a fully qualified domain name (FQDN), including the extension\n(e.g., `example.com`, `mybrand.app`). The domain name uniquely identifies\na registration. Cloudflare permits only one registration per domain, making\nthe domain name a natural idempotency key for registration requests.\n |
| privacy_mode? | enum | Sets the WHOIS privacy mode for the registration. Defaults to `redaction`.\n- `off`: Disables WHOIS privacy.\n- `redaction`: Requests WHOIS redaction where the extension supports it.\n Some extensions exclude privacy and redaction.\n |
| years? | number | Sets the registration term from 1 to 10 years. When omitted, this\nfield defaults to the registry's minimum registration period for the\nextension. Most extensions require 1 year, while some require longer\nminimum terms (e.g., `.ai` requires 2 years).\n\nEach registry may also enforce its own maximum registration term. A\nrequest above that maximum fails. When uncertain, omit this field to\nuse the default.\n |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Registrations
fn get(id: string)
Get a Registrations
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Registrations |
fn lookup()
Look up an existing Registrations by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Registrations by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Registrations to import |
fn update(identifier?: string)
Update Registrations attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Registrations by id (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync Registrations state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Registrations by id (e.g. one discovered by list) |
Resources
state(infinite)— Registrations resource state
04Previous Versions
2026.08.26.1
- Updated: registrations
2026.08.25.2
- Updated: registrations
2026.08.25.1
- Updated: registrations
2026.07.24.1
- Updated: registrations
2026.07.21.1
- Updated: registrations
2026.07.18.2
Modified 1 models
2026.06.08.2
- Updated: registrations
2026.05.29.1
- Updated: registrations
2026.05.22.1
- Added: registrations
05Stats
A
100 / 100
Downloads
0
Archive size
15.7 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels