Cloudflare/registrar
@swamp/cloudflare/registrarv2026.07.24.1
01README
Cloudflare registrar infrastructure models
02Release Notes
- Updated: registrations
03Models
@swamp/cloudflare/registrar/registrationsv2026.07.24.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 | User acknowledgements required by a specific extension or premium\nregistration flow. The expected keys are described by the extension\nregistration schema returned by the extension discovery endpoint.\n |
| contact_extensions? | record | Registry-specific contact extension values for the registrant. The\nrequired keys and allowed values vary by extension and are described\nby `GET /accounts/{account_id}/registrar/extensions/{extension}` in\nthe `registration_schema.properties.contact_extensions` object.\n\nExamples include `.us` nexus fields, `.uk` registrant type fields,\nand `.ca` legal type fields. Omit this object for extensions whose\nregistration schema does not include `contact_extensions`.\n |
| contacts? | object | Contact data for the registration request.\n\nThe per-extension schema returned by\n`GET /accounts/{account_id}/registrar/extensions/{extension}` is the\nauthoritative contract for which contact roles are accepted. Every\ncurrently supported extension requires only `contacts.registrant` from\nAPI callers. Additional roles such as `technical`, `administrator`, and\n`billing` may be provided when the extension schema includes them. If a\nregistry requires one of those roles and the caller omits it |
| domain_name | string | Fully qualified domain name (FQDN) including the extension\n(e.g., `example.com`, `mybrand.app`). The domain name uniquely\nidentifies a registration — the same domain cannot be registered\ntwice, making it a natural idempotency key for registration requests.\n |
| privacy_mode? | enum | WHOIS privacy mode for the registration. Defaults to `redaction`.\n- `off`: Do not request WHOIS privacy.\n- `redaction`: Request WHOIS redaction where supported by the extension.\n Some extensions do not support privacy/redaction.\n |
| years? | number | Number of years to register (1–10). If omitted, defaults to the\nminimum registration period required by the registry for this\nextension. For most extensions this is 1 year, but some extensions\nrequire longer minimum terms (e.g., `.ai` requires a minimum of\n2 years).\n\nThe registry for each extension may also enforce its own maximum\nregistration term. If the requested value exceeds the registry's\nmaximum, the registration will be rejected. When in doubt, use the\ndefault by omitting this f |
| 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.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.9 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