Set transfer-lock setting for a domain
View as MarkdownSets the transfer lock (also known as registrar lock) for the domain.
Full description
Sets the transfer lock (also known as registrar lock) for the domain. When enabled, the domain cannot be transferred to another registrar without first unlocking it. Disabling transfer lock is typically a prerequisite step for initiating an outbound domain transfer. Returns a DomainOperation; propagation to the registry is asynchronous.
Authorization
bearerAuth Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer <token>.
In: header
Path Parameters
The domain name in punycode A-label form (e.g., example.com). For IDNs, use the punycode representation.
Header Parameters
Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.
uuidClient-generated unique key (UUID recommended). Retrying a mutating request with the same Idempotency-Key returns the original response without creating a duplicate side effect. Required on all execute endpoints.
16 <= length <= 64Request Body
application/json
Whether transfer lock should be enabled for this domain. When true, the domain cannot be transferred to another registrar without first unlocking it. This helps prevent unauthorized domain transfers.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/domain-names/example.com/transfer-lock" \ -H "Idempotency-Key: 9f1c2e7a-4b3d-4e8f-a1c2-3d4e5f6a7b8c" \ -H "Content-Type: application/json" \ -d 'true'{ "operationId": null, "type": null, "domain": "string", "status": null, "result": { "expiresAt": "string", "orderId": "string", "updatedAt": "string" }, "error": { "name": "string", "correlationId": "string", "message": "string", "informationLink": "string", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "links": [ { "href": "http://example.com", "rel": "string", "title": "string", "targetMediaType": "string", "targetSchema": null, "method": "string", "submissionMediaType": "application/json", "submissionSchema": null } ] }, "links": [ { "href": "http://example.com", "rel": "string", "title": "string", "targetMediaType": "string", "targetSchema": null, "method": "string", "submissionMediaType": "application/json", "submissionSchema": null } ], "createdAt": "string", "updatedAt": "string"}Agent & Automation Notes
domains.domain:read, domains.domain:create, domains.dns:update, domains.nameserver:updateRelated
Last updated on
How is this guide?