Update Domain Lock Status
whmcs_update_domain_lock_statusLock or unlock a domain by providing its ID and a boolean lock status. This controls transfer protection.
Instructions
Lock or unlock a domain
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domainid | Yes | Domain ID | |
| lockstatus | No | Lock status (true to lock) |
Implementation Reference
- src/index.ts:732-748 (registration)Registration of the 'whmcs_update_domain_lock_status' tool with MCP server. Defines input schema (domainid required, lockstatus optional boolean) and delegates to whmcsClient.updateDomainLockingStatus().
server.registerTool( 'whmcs_update_domain_lock_status', { title: 'Update Domain Lock Status', description: 'Lock or unlock a domain', inputSchema: { domainid: z.number().describe('Domain ID'), lockstatus: z.boolean().optional().describe('Lock status (true to lock)'), }, }, async (params) => { const result = await whmcsClient.updateDomainLockingStatus(params); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }], }; } ); - src/index.ts:737-740 (schema)Input schema for the tool: domainid (number, required) and lockstatus (boolean, optional).
inputSchema: { domainid: z.number().describe('Domain ID'), lockstatus: z.boolean().optional().describe('Lock status (true to lock)'), }, - src/index.ts:742-747 (handler)Handler function that calls whmcsClient.updateDomainLockingStatus(params) and returns the JSON-stringified result.
async (params) => { const result = await whmcsClient.updateDomainLockingStatus(params); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }], }; } - src/whmcs-client.ts:893-900 (helper)The WhmcsApiClient.updateDomainLockingStatus() helper method that calls the WHMCS API action 'DomainUpdateLockingStatus' with the provided params.
* Update domain lock status */ async updateDomainLockingStatus(params: { domainid: number; lockstatus?: boolean; }) { return this.call<WhmcsApiResponse>('DomainUpdateLockingStatus', params); }