Domain Transfer - Domain Name API

Domain transfers allow existing domain names to be moved to a new domain registrar.

• GET/dom/transfer

  Gets all domain transfers on an account

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  200 Response

  {
      "result" : [
          {
              "created_on" : "2023-06-02",
              "domain" : "example.com",
              "updated_on" : "2023-06-02",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• GET/dom/transfer/{uuid}

  Gets a specific domain transfer

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the DomainTransfer to query

  Response Details

  200 Response

  {
      "result" : {
          "created_on" : "2023-06-02",
          "domain" : "example.com",
          "updated_on" : "2023-06-02",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• Chargeable *

  POST/dom/transfer

  Begins the transfer process for a domain name

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  POST body

  • Name

  • Type

  • Required

  • • allow_premium

    • boolean

    • False

    This flag is required for premium domains to acknowledge the greater cost. Defaults to false

  • • auth_code

    • String

    • False

    The current EPP authorization code for the domain

  • • auto_renew

    • boolean

    • False

    Sets the auto-renew value for the domain name after the transfer process has completed

  • • domain_name

    • String

    • True

    The domain name to begin a transfer process for

  • • keep_contacts

    • boolean

    • False

    Should the domain keep it's current contact data when the transfer completes

  • • keep_name_servers

    • boolean

    • False

    Should the domain keep it's current name servers once the transfer completes

  • • nameserver_group_uuid

    • String

    • False

    The UUID of the name server group to apply to the domain if keep_name_servers is false

  JSON all-fields example:

  {
      "allow_premium" : true,
      "auth_code" : "AUTH-CODE-1",
      "auto_renew" : true,
      "domain_name" : "example.com",
      "keep_contacts" : true,
      "keep_name_servers" : true,
      "nameserver_group_uuid" : "0b1ed418-0867-4491-a05f-f2054042a97a"
  }

  Response Details

  201 Response

  {
      "result" : {
          "created_on" : "2023-06-02",
          "domain" : "example.com",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 201,
      "status_message" : "Created"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  409 Response

  {
      "result" : {},
      "status_code" : 409,
      "status_message" : "Conflict"
  }

• DELETE/dom/transfer/{uuid}

  Cancels an outstanding domain transfer

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the transfer to cancel

  Response Details

  204 Response

  {
      "result" : {},
      "status_code" : 204,
      "status_message" : "No Content"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }