{
"opencollection": "1.0.0",
"info": {
"name": "Abuse Actions Domains API",
"version": "2.0.0"
},
"items": [
{
"info": {
"name": "Domains",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve details for the specified Domain",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain name whose details are to be retrieved"
},
{
"name": "includes",
"value": "",
"type": "query",
"description": "Optional details to be included in the response"
}
]
},
"docs": "Retrieve details for the specified Domain"
},
{
"info": {
"name": "Retrieve change of registrant information",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/changeOfRegistrant",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain whose change of registrant information is to be retrieved"
}
]
},
"docs": "Retrieve change of registrant information"
},
{
"info": {
"name": "Cancels a pending change of registrant request for a given domain",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/changeOfRegistrant",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain whose change of registrant is to be cancelled"
}
]
},
"docs": "Cancels a pending change of registrant request for a given domain"
},
{
"info": {
"name": "Add the specifed DNSSEC records to the domain",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/dnssecRecords",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to add the DNSSEC record for"
}
]
},
"docs": "Add the specifed DNSSEC records to the domain"
},
{
"info": {
"name": "Remove the specifed DNSSEC record from the domain",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/dnssecRecords",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to delete the DNSSEC record for"
}
]
},
"docs": "Remove the specifed DNSSEC record from the domain"
},
{
"info": {
"name": "Replaces the existing name servers on the domain.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/nameServers",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain whose name servers are to be replaced"
}
]
},
"docs": "Replaces the existing name servers on the domain."
},
{
"info": {
"name": "Retrieve privacy email forwarding settings showing where emails are delivered",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/privacy/forwarding",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain name whose details are to be retrieved"
}
]
},
"docs": "Retrieve privacy email forwarding settings showing where emails are delivered"
},
{
"info": {
"name": "Update privacy email forwarding settings to determine how emails are delivered",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/privacy/forwarding",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain name whose details are to be retrieved"
}
]
},
"docs": "Update privacy email forwarding settings to determine how emails are delivered"
},
{
"info": {
"name": "Purchase a restore for the given domain to bring it out of redemption",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/redeem",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to request redeem for"
}
]
},
"docs": "Purchase a restore for the given domain to bring it out of redemption"
},
{
"info": {
"name": "Renew the specified Domain",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/renew",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to be renewed"
}
]
},
"docs": "Renew the specified Domain"
},
{
"info": {
"name": "Query the current transfer status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/transfer",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain Name"
}
]
},
"docs": "Query the current transfer status"
},
{
"info": {
"name": "Purchase and start or restart transfer process",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/transfer",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to transfer in"
}
]
},
"docs": "Purchase and start or restart transfer process"
},
{
"info": {
"name": "Validate the request body using the Domain Transfer Schema for the specified TLD",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/transfer/validate",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to transfer in"
}
]
},
"docs": "Validate the request body using the Domain Transfer Schema for the specified TLD"
},
{
"info": {
"name": "Accepts the transfer in",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/transferInAccept",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to accept the transfer in for"
}
]
},
"docs": "Accepts the transfer in"
},
{
"info": {
"name": "Cancels the transfer in",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/transferInCancel",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to cancel the transfer in for"
}
]
},
"docs": "Cancels the transfer in"
},
{
"info": {
"name": "Restarts transfer in request from the beginning",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/transferInRestart",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to restart the transfer in"
}
]
},
"docs": "Restarts transfer in request from the beginning"
},
{
"info": {
"name": "Retries the current transfer in request with supplied Authorization code",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/transferInRetry",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to retry the transfer in"
}
]
},
"docs": "Retries the current transfer in request with supplied Authorization code"
},
{
"info": {
"name": "Initiate transfer out to another registrar for a .uk domain.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/transferOut",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to initiate the transfer out for"
},
{
"name": "registrar",
"value": "",
"type": "query",
"description": "Registrar tag to push transfer to"
}
]
},
"docs": "Initiate transfer out to another registrar for a .uk domain."
},
{
"info": {
"name": "Accept transfer out",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/transferOutAccept",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to accept the transfer out for"
}
]
},
"docs": "Accept transfer out"
},
{
"info": {
"name": "Reject transfer out",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/:domain/transferOutReject",
"headers": [
{
"name": "X-Request-Id",
"value": ""
}
],
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "domain",
"value": "",
"type": "path",
"description": "Domain to reject the transfer out for"
},
{
"name": "reason",
"value": "",
"type": "query",
"description": "Transfer out reject reason"
}
]
},
"docs": "Reject transfer out"
},
{
"info": {
"name": "Retrieve the forwarding information for the given fqdn",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v2/customers/:customerId/domains/forwards/:fqdn",
"params": [
{
"name": "customerId",
"value": "",
"type": "path",
"description": "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id."
},
{
"name": "fqdn",
"value": "",
"type": "path",
"description": "The fully qualified domain name whose forwarding details are to be retrieved."
},
{
"name": "includeSubs",
"value": "",
"type": "query",
"description": "Optionally include all sub domains if the fqdn specified is a domain and not a sub domain."
}
]
},
"docs": "Notes: