Overview
Error Handling

Methods

API Documentation (API Version bleed)

Network/DNS/Domain/Transfer/

DESCRIPTION

This section of the API allows for working with transfers for a given domain.

cancelTransfer

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/Transfer/cancelTransfer

Description:

Cancel a given transfer, if possible.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

createIncoming

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/Transfer/createIncoming

Description:

Create an incoming domain transfer.

Parameters:

ParameterTypeNotes
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
eppCodeA string of text, containing no newlines or other control characters.* Required

Returns:

FieldTypeNotes
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
idA valid id number (a positive integer).
is_cancellableA boolean value (0 or 1).
is_completeA boolean value (0 or 1).
registrar_detail_status_descriptionA string of text, containing no newlines or other control characters.* Optional
registrar_detail_status_idA positive integer value (i.e. 1 and up).* Optional
registrar_order_idAn integer value.* Optional
registrar_status_idA positive integer value (i.e. 1 and up).* Optional
transfer_typeOne of: 'incoming', 'outgoing'
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

createOutgoing

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/Transfer/createOutgoing

Description:

Create an outgoing domain transfer.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
idA valid id number (a positive integer).
is_cancellableA boolean value (0 or 1).
is_completeA boolean value (0 or 1).
registrar_detail_status_descriptionA string of text, containing no newlines or other control characters.* Optional
registrar_detail_status_idA positive integer value (i.e. 1 and up).* Optional
registrar_order_idAn integer value.* Optional
registrar_status_idA positive integer value (i.e. 1 and up).* Optional
transfer_typeOne of: 'incoming', 'outgoing'
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

delete

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/Transfer/delete

Description:

Delete a transfer record for the given domain.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

details

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/Transfer/details

Description:

Delete a transfer record for the given domain.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
idA valid id number (a positive integer).
is_cancellableA boolean value (0 or 1).
is_completeA boolean value (0 or 1).
registrar_detail_status_descriptionA string of text, containing no newlines or other control characters.* Optional
registrar_detail_status_idA positive integer value (i.e. 1 and up).* Optional
registrar_order_idAn integer value.* Optional
registrar_status_idA positive integer value (i.e. 1 and up).* Optional
transfer_typeOne of: 'incoming', 'outgoing'
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

list

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/Transfer/list

Description:

List a transfer records for the given account.

Parameters:

ParameterTypeNotes
order_byAn associative array containing the fields:
 
fieldThe value: 'created_date'* Required
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: asc
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
idA valid id number (a positive integer).
is_cancellableA boolean value (0 or 1).
is_completeA boolean value (0 or 1).
registrar_detail_status_descriptionA string of text, containing no newlines or other control characters.* Optional
registrar_detail_status_idA positive integer value (i.e. 1 and up).* Optional
registrar_order_idAn integer value.* Optional
registrar_status_idA positive integer value (i.e. 1 and up).* Optional
transfer_typeOne of: 'incoming', 'outgoing'
uniq_idA six-character identifier, containing only capital letters and digits.
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

resendEmail

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/Transfer/resendEmail

Description:

Resend the authorization email for an incoming transfer

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

sendEPPCode

URL:

https://api.liquidweb.com/bleed/Network/DNS/Domain/Transfer/sendEPPCode

Description:

Sends the EPP code for a given domain

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types