DomainVersion

One immutable lifecycle event for a domain: the complete frozen snapshot at this version plus the field-level changes from the previous version.

  • object
    Type: string

    Resource type identifier

  • id
    Type: string

    Unique identifier for this version event

  • domain_id
    Type: string

    Identifier of the domain this version belongs to

  • version
    Type: integer

    Per-domain monotonic version number, starting at 1

  • change_type
    Type: string · DomainVersionChangeTypeenum

    Classification of the lifecycle event that produced this version

    Classification of the lifecycle event that produced a version. Values are: - registration_pending: the v1 row written when a registration starts - registered: the registry confirmed the create and the domain went active - renewed: a renewal extended the registration, advancing only the expiry - imported: an external inventory row was created from a non-sponsor lookup - synced: the freshness sweep refreshed an external row from the registry - auth_staged: a validated transfer auth code was attached to or replaced on a row - transfer_pending: an inbound transfer was requested and the row is awaiting the registry verdict - transferred: an inbound transfer was approved and the row became a sponsored registration - transfer_failed: an inbound transfer was refused and the row returned to external monitoring

    values
    • registration_pending = ChangeTypeRegistrationPending
    • registered = ChangeTypeRegistered
    • renewed = ChangeTypeRenewed
    • imported = ChangeTypeImported
    • synced = ChangeTypeSynced
    • auth_staged = ChangeTypeAuthStaged
    • transfer_pending = ChangeTypeTransferPending
    • transferred = ChangeTypeTransferred
    • transfer_failed = ChangeTypeTransferFailed
  • change_summary
    Type: string

    Human-readable summary of the change; omitted when none was recorded

  • snapshot
    Type: object · DomainVersionSnapshot

    Complete frozen state of the domain at this version

    Frozen state of a domain at a single version.

    • object
      Type: string

      Resource type identifier

    • auto_renew
      Type: boolean

      Whether auto-renewal was enabled at this version; omitted when unknown

    • period
      Type: object · Period

      Registration term at this version; omitted when unknown

      Registration term carrying a count and the unit it is denominated in.

    • expires_at
      Type: string

      Registry expiry at this version; omitted when unknown

    • roid
      Type: string

      Registry object id (ROID) at this version; omitted before the registry confirms the create

    • sponsoring_registrar
      Type: string

      Sponsoring registrar at this version; omitted before the registry confirms the create

    • auth_info
      Type: string

      Masked marker that a transfer auth code was set at this version; omitted when none was set or the version predates recording. Never carries the value

    • contacts
      Type: array object[] · DomainVersionContact[]

      Frozen role contacts assigned at this version; empty when none were assigned

      Frozen copy of a contact assigned to a role at a single version.

    • nameservers
      Type: array string[]

      Delegated nameserver hostnames at this version

    • epp_statuses
      Type: array string[]

      EPP status codes set at this version

    • ds_records
      Type: array object[] · DomainVersionDS[]

      DNSSEC delegation-signer records at this version

      Frozen DNSSEC delegation-signer record at a single version.

  • changes
    Type: array object[] · DomainVersionChange[]

    Field-level changes versus the previous version; empty for the first version

    A single field-level change between this version and the previous one. kind tells the client how to render from/to.

    • object
      Type: string

      Resource type identifier

    • field
      Type: string

      Snake-case name of the field that changed

    • label
      Type: string

      Human-readable label for the changed field

    • kind
      Type: string enum

      How a client should render from/to

      values
      • date
      • toggle
      • count
      • text
      • list
      • reference
    • from
      Type: object

      Previous value; omitted when the field was unset before this version

    • to
      Type: object

      New value; omitted when the field was unset at this version

  • changed_by
    Type: object · Actor

    Actor that produced this version; omitted when attribution is unavailable

    Principal behind an action. kind is the principal and method is the credential it acted through; the matching nested field (user, personal_key, org_key) is populated when one applies.

    • object
      Type: string

      Resource type identifier

    • kind
      Type: string

      The kind of principal: user, org, visitor, or system.

    • method
      Type: string

      The credential the principal acted through: session, personal_key, org_key, or system.

    • user
      Type: object · User

      Full user profile. Populated for the user kind when the user row is resolvable; null otherwise, including when the user was deleted after the action was recorded.

      User profile with identity and display metadata

    • personal_key
      Type: object · ActorPersonalKey

      Personal API key pointer. Populated only for method personal_key.

      Personal API key pointer inside an Actor envelope.

    • org_key
      Type: object · ActorOrgKey

      Org API key pointer. Populated only for the org kind.

      Org API key pointer inside an Actor envelope.

  • occurred_at
    Type: string

    When this version was recorded