Skip to main content

EPP Code and Domain Sync

Get EPP Code

GET /domains/{domain}/eppcode

Gets the EPP code for a domain.

Authentication uses the required username and token headers.

Path variable:

  • domain: domain name, for example example.test.ly
Get EPP code
curl --request GET \
--url "https://my.register.ly/modules/addons/DomainsReseller/api/index.php/domains/example.test.ly/eppcode" \
--header "username: [email protected]" \
--header "token: <generated-token>"

HTTP 200 success response:

{
"eppcode": "rK250R73CP",
"status": "success",
"message": ""
}

Treat an EPP code as a sensitive transfer credential. Do not expose it in browser code, logs, analytics, tickets, or client-side error reports.

VALIDATION REQUIRED: Confirm whether retrieval returns an existing code or generates/rotates one, and confirm lock requirements, unsupported statuses/TLDs, error bodies, and audit behavior.

Domain Sync

POST /domains/{domain}/sync

Returns documented domain lifecycle fields from the sync operation.

Path variable:

  • domain: domain name, for example example.test.ly
Run domain sync
curl --request POST \
--url "https://my.register.ly/modules/addons/DomainsReseller/api/index.php/domains/example.test.ly/sync" \
--header "Content-Type: application/x-www-form-urlencoded" \
--header "username: [email protected]" \
--header "token: <generated-token>"

HTTP 200 success response:

{
"expirydate": "2024-03-09",
"active": true,
"expired": false,
"transferredAway": false
}

VALIDATION REQUIRED: The public contract does not establish whether /sync only reads registry state, updates Register.ly/WHMCS data, or performs both. Its repeated-call side effects and retry safety are also unspecified.

Do not schedule or automatically retry this operation until its ownership and side effects are confirmed.