Get DNS service status for an order
Returns whether the DNS service is active for the order.
path Parameters
orderIdOrder Id (required).
Get DNS service status for an order › Responses
OK
activeWhether the service is active
parentKeycustomerIdresellerIdstatusOperation status
messageStatus message
Get domain forwarding status for an order
Returns whether domain forwarding is active for the order.
path Parameters
orderIdOrder Id (required).
Get domain forwarding status for an order › Responses
OK
activeWhether domain forwarding is active
parentKeyParent reseller chain key
customerIdCustomer identifier
resellerIdReseller identifier
statusOperation status when present
messageError or status message when the order cannot be evaluated
Search orders
Returns orders matching the search criteria, with pagination.
query Parameters
sizeSize.
pagePage.
statusStatus.
customerIdCustomer Id.
domainNameDomain Name.
creationTimeStartCreation Time Start.
creationTimeEndCreation Time End.
endTimeStartEnd Time Start.
endTimeEndEnd Time End.
sortSort.
onlyRecurringOnly Recurring.
listChildOrdersList Child Orders.
Search orders › Responses
OK
totalItemsTotal matching orders in the result set
itemsOnPageOrders returned on this page
totalPagesTotal number of pages for the search
totalCountOrder summaries
productNamestatusOperation status when present
messageStatus message when present
Suspend or unsuspend an order
Suspends or unsuspends an order.
path Parameters
orderIdSuspend or unsuspend an order › Request Body
suspendedWhen true, suspends the order; when false, unsuspends.
reasonSuspension reason (required when suspended is true).
Suspend or unsuspend an order › Responses
OK
actionStatusAction status
actionStatusDescAction status description
actionTypeDescAction type description
entityIdEntity identifier
eaqIdAction queue identifier
actionTypeAction type
descriptionAdditional description when provided.
statusStatus text
messageResult message
Suspend or unsuspend multiple orders
Suspends or unsuspends multiple orders in bulk.
Suspend or unsuspend multiple orders › Request Body
suspendedWhen true, suspends the orders; when false, unsuspends.
orderIdsOrder identifiers to update.
reasonSuspension reason (required when suspended is true).
removeChildLocksWhether to remove child locks when unsuspending.
Suspend or unsuspend multiple orders › Responses
OK
successWhether the bulk operation succeeded.