Domain transfer lock API

Enable domain transfer lock

This endpoint is currently in Public Preview. During the Preview, period changes may occur at any time.

Consider using our official clients to reduce the likelihood of breaking changes. If you are using or planning to use this endpoint we'd like to hear your feedback.

Enables the transfer lock for the domain.

POST /:account/registrar/domains/:domain/transfer_lock

Parameters

Name Type Description
:account integer The account id
:domain string, integer The domain name or id

Example

Enable the transfer lock for the domain example.com in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -X POST \
      https://api.dnsimple.com/v2/1010/registrar/domains/example.com/transfer_lock

Response

Responds with HTTP 201 on success.

{
  "data": {
    "enabled": true
  }
}

Errors

Responds with HTTP 400 if the domain transfer lock cannot be enabled for the domain.

Responds with HTTP 401 in case of case of authentication issues.

Responds with HTTP 404 if the domain does not exist.

Disable domain transfer lock

This endpoint is currently in Public Preview. During the Preview, period changes may occur at any time.

Consider using our official clients to reduce the likelihood of breaking changes. If you are using or planning to use this endpoint we'd like to hear your feedback.

Disables the transfer lock for the domain.

DELETE /:account/registrar/domains/:domain/transfer_lock

Parameters

Name Type Description
:account integer The account id
:domain string, integer The domain name or id

Example

Disable the transfer lock for the domain example.com in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      -X DELETE \
      https://api.dnsimple.com/v2/1010/registrar/domains/example.com/transfer_lock

Response

Responds with HTTP 200 on success.

{
  "data": {
    "enabled": false
  }
}

Errors

Responds with HTTP 400 if the domain transfer lock cannot be disabled for the domain.

Responds with HTTP 401 in case of case of authentication issues.

Responds with HTTP 404 if the domain does not exist.

Retrieve domain transfer lock status

GET /:account/registrar/domains/:domain/transfer_lock

Get the status of the domain transfer lock, indicating whether it is currently enabled or disabled.

Parameters

Name Type Description
:account integer The account id
:domain string, integer The domain name or id

Example

Get the domain transfer lock status for the domain example.com in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      https://api.dnsimple.com/v2/1010/registrar/domains/example.com/transfer_lock

Response

Responds with HTTP 200.

{
  "data": {
    "enabled": true
  }
}

Errors

Responds with HTTP 401 in case of case of authentication issues.

Responds with HTTP 404 if the domain does not exist.