Security & Locks

Server

Download schema

Add reseller lock to domain

POST

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/reseller-lock

Authorization (header)

+X-User-Id (header)

Returns the result of the domain operation, including action tracking metadata.

Add reseller lock to domain › path Parameters

orderId

integer · int32 · required

Add reseller lock to domain › Request Body

Applies a Reseller Lock on the specified Domain Registration Order.

AddResellerLockRequest

reason

string · minLength: 1 · required

Reason for applying the Reseller Lock.

Add reseller lock to domain › Responses

Returns the result of the domain operation, including action tracking metadata.

AddResellerLockResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type.

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the queued operation.

currentAction

string

description

string

Free-text description of the action or domain row.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

Enable or disable theft protection

PUT

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/theft-protection

Authorization (header)

+X-User-Id (header)

Enables or disables theft protection for a domain order.

Enable or disable theft protection › path Parameters

orderId

integer · int32 · required

Enable or disable theft protection › Request Body

Enables or disables theft protection for a domain order.

UpdateTheftProtectionRequest

enabled

boolean · required

When true, enables theft protection; when false, disables it.

otp

string

One-time password when required for the operation.

twoFactorType

string

Two-factor authentication type when required.

Enable or disable theft protection › Responses

Result of enabling or disabling theft protection.

UpdateTheftProtectionResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type (for example, Enable Theft Protection).

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the operation (for example, Lock or Unlock).

description

string

Domain name or free-text description of the action.

status

string

Overall operation status (for example, Success or Failed).

error

string

Error code from the operation (for example, NoError).

PUT/domains/{orderId}/theft-protection

curl https://api.sandbox.resellerclub.com/v2/domains/:orderId/theft-protection \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "enabled": true,
  "otp": "otp",
  "twoFactorType": "twoFactorType"
}'

Example Request Body

{
  "enabled": true,
  "otp": "otp",
  "twoFactorType": "twoFactorType"
}

json

Example Responses

{
  "actionStatus": "actionStatus",
  "actionStatusDesc": "actionStatusDesc",
  "actionTypeDesc": "actionTypeDesc",
  "entityId": "entityId",
  "eaqId": "eaqId",
  "actionType": "actionType",
  "description": "description",
  "status": "status",
  "error": "error"
}

json

application/json

List locks applied to a domain

GET

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/locks

Authorization (header)

+X-User-Id (header)

Gets the list of the Locks applied on the specified Domain Registration Order.

List locks applied to a domain › path Parameters

orderId

integer · int32 · required

List locks applied to a domain › Responses

Returns locks currently applied to the domain. The registrar may return boolean lock flags (`transferlock`, `customerlock`, `resellerlock`), nested indexed lock detail under those keys, or both. Order-level flags are returned at the response root; per-lock detail rows are returned in `lockDetails`.

ListDomainLocksResponse

resellerLock

boolean

Whether the reseller lock is enabled on the order.

transferLock

boolean

Whether the registrar transfer lock is enabled.

customerLock

boolean

Whether the customer lock is enabled on the order.

DomainLockDetail[]

Detail rows for locks currently applied to the requested domain order.

Remove reseller lock from domain

DELETE

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/reseller-lock

Authorization (header)

+X-User-Id (header)

Returns the result of the domain operation, including action tracking metadata.

Remove reseller lock from domain › path Parameters

orderId

integer · int32 · required

Remove reseller lock from domain › Responses

Returns the result of the domain operation, including action tracking metadata.

RemoveResellerLockResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type.

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the queued operation.

currentAction

string

description

string

Free-text description of the action or domain row.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

Privacy & GDPR TLD Catalog

Domains APIs

Security & Locks

Server

Download schema

Add reseller lock to domain

POST

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/reseller-lock

Authorization (header)

+X-User-Id (header)

Returns the result of the domain operation, including action tracking metadata.

Add reseller lock to domain › path Parameters

orderId

integer · int32 · required

Add reseller lock to domain › Request Body

Applies a Reseller Lock on the specified Domain Registration Order.

AddResellerLockRequest

reason

string · minLength: 1 · required

Reason for applying the Reseller Lock.

Add reseller lock to domain › Responses

Returns the result of the domain operation, including action tracking metadata.

AddResellerLockResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type.

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the queued operation.

currentAction

string

description

string

Free-text description of the action or domain row.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

Enable or disable theft protection

PUT

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/theft-protection

Authorization (header)

+X-User-Id (header)

Enables or disables theft protection for a domain order.

Enable or disable theft protection › path Parameters

orderId

integer · int32 · required

Enable or disable theft protection › Request Body

Enables or disables theft protection for a domain order.

UpdateTheftProtectionRequest

enabled

boolean · required

When true, enables theft protection; when false, disables it.

otp

string

One-time password when required for the operation.

twoFactorType

string

Two-factor authentication type when required.

Enable or disable theft protection › Responses

Result of enabling or disabling theft protection.

UpdateTheftProtectionResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type (for example, Enable Theft Protection).

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the operation (for example, Lock or Unlock).

description

string

Domain name or free-text description of the action.

status

string

Overall operation status (for example, Success or Failed).

error

string

Error code from the operation (for example, NoError).

PUT/domains/{orderId}/theft-protection

curl https://api.sandbox.resellerclub.com/v2/domains/:orderId/theft-protection \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "enabled": true,
  "otp": "otp",
  "twoFactorType": "twoFactorType"
}'

Example Request Body

{
  "enabled": true,
  "otp": "otp",
  "twoFactorType": "twoFactorType"
}

json

Example Responses

{
  "actionStatus": "actionStatus",
  "actionStatusDesc": "actionStatusDesc",
  "actionTypeDesc": "actionTypeDesc",
  "entityId": "entityId",
  "eaqId": "eaqId",
  "actionType": "actionType",
  "description": "description",
  "status": "status",
  "error": "error"
}

json

application/json

List locks applied to a domain

GET

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/locks

Authorization (header)

+X-User-Id (header)

Gets the list of the Locks applied on the specified Domain Registration Order.

List locks applied to a domain › path Parameters

orderId

integer · int32 · required

List locks applied to a domain › Responses

ListDomainLocksResponse

resellerLock

boolean

Whether the reseller lock is enabled on the order.

transferLock

boolean

Whether the registrar transfer lock is enabled.

customerLock

boolean

Whether the customer lock is enabled on the order.

DomainLockDetail[]

Detail rows for locks currently applied to the requested domain order.

Remove reseller lock from domain

DELETE

https://api.sandbox.resellerclub.com/v2

/domains/{orderId}/reseller-lock

Authorization (header)

+X-User-Id (header)

Returns the result of the domain operation, including action tracking metadata.

Remove reseller lock from domain › path Parameters

orderId

integer · int32 · required

Remove reseller lock from domain › Responses

Returns the result of the domain operation, including action tracking metadata.

RemoveResellerLockResponse

actionStatus

string

Status code of the queued domain action.

actionStatusDesc

string

Human-readable description of the action status.

actionTypeDesc

string

Human-readable description of the action type.

entityId

string

Internal entity identifier for the domain order.

eaqId

string

Entity action queue identifier for tracking the operation.

actionType

string

Action type code for the queued operation.

currentAction

string

description

string

Free-text description of the action or domain row.

status

string

Overall operation status (for example, Success or Failed).

message

string

Additional status or error message from the operation.

Privacy & GDPR TLD Catalog