Support

Account-scoped Domains operations under /v1/domains. Search, register, list, DNS, privacy, renewals, and transfer.

Overview

The v1 namespace exposes Domains operations that act on the domains owned by the authenticated account. Caller identity is established by the Authorization header alone; some operations also accept an X-Shopper-Id header to act on behalf of a specific shopper.

The v1 namespace is account-scoped; use v2 when you need async operation tracking (action queues, status polling, and notifications). For a task-shaped guide layered on top of these endpoints, see Use the API → Domains.

Machine-readable spec

The complete OpenAPI spec for the v1 namespace is available at /openapi/domains-v1.json — useful for code generation, SDK tooling, and LLM context.

Operation groups

The v1 namespace is organized into five operation groups, each rendered on its own reference page below.

Authentication and scopes

Every v1 operation requires an Authorization header carrying a Personal Access Token (Bearer) or a legacy sso-key credential. PATs use the granular Domains & DNS scopes listed in Authentication, like domains.domain:read, domains.domain:update, domains.dns:update, and domains.transfer:execute.

Conventions

ConcernWhere it's documented
Error envelope and retry semanticsErrors
Rate limits (60 requests/minute per credential)Rate limits
Cursor-based pagination on GET /v1/domainsPagination

Agent & Automation Notes

Scopesdomains.domain:read, domains.domain:create, domains.domain:delete, domains.domain:update, domains.contact:update, domains.dns:update, domains.transfer:execute
Rate limit60 req/min per credential
On failureGET operations are safe to retry. PUT/PATCH DNS are idempotent by shape. POST purchase is NOT idempotent — verify state before retrying.

Last updated on

How is this guide?

On this page