Save Registrar Lock - Mint Starter Kit

curl --request POST \ --url https://vicem.com/modules/addons/DomainsReseller/api/index.php/domains/{domain}/lock \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'token: <token>' \ --header 'username: <username>' \ --data domain=example.com \ --data lockstatus=locked

Headers

username

string<email>

required

Reseller email address registered in WHMCS

Example:

"[email protected]"

token

string

required

HMAC-SHA256 authentication token.

PHP formula: base64_encode(hash_hmac('sha256', $apiKey, $email . ':' . gmdate('y-m-d H')))

Important: hash_hmac without the 3rd parameter true (returns hex, not binary), then base64_encode of the hex result. The token is 88 characters long.

An optional timestamp header (Unix timestamp, 60-second tolerance) can be sent to synchronize time.

Example:

"YTk4YjRmNjI..."

Path Parameters

domain

string

required

Domain name (e.g. example.com)

Example:

"example.com"

Body

application/x-www-form-urlencoded

domain

string

required

Domain name

Example:

"example.com"

lockstatus

enum<string>

required

locked or unlocked

Available options:

locked,

unlocked

Example:

"locked"

Response

Success - Registrar result

The response is of type object.