whmcs_get_domain_lock_status
Check domain lock status in WHMCS to determine if a domain is secured against transfers using the domain ID.
Instructions
Get lock/unlock status for a domain
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domainid | Yes | Domain ID |
Implementation Reference
- src/whmcs-client.ts:889-894 (handler)The core handler method `getDomainLockingStatus` in WhmcsApiClient class that makes the WHMCS API call to 'DomainGetLockingStatus' to retrieve the domain's lock status./** * Get domain locking status */ async getDomainLockingStatus(params: { domainid: number }) { return this.call<WhmcsApiResponse & { lockstatus: string }>('DomainGetLockingStatus', params); }
- src/index.ts:697-711 (registration)MCP tool registration for 'whmcs_get_domain_lock_status', including input schema definition and thin wrapper handler that delegates to WhmcsApiClient.'whmcs_get_domain_lock_status', { title: 'Get Domain Lock Status', description: 'Get lock/unlock status for a domain', inputSchema: { domainid: z.number().describe('Domain ID'), }, }, async (params) => { const result = await whmcsClient.getDomainLockingStatus(params); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }], }; } );
- src/index.ts:702-704 (schema)Zod input schema validation for the tool, requiring a numeric domainid.domainid: z.number().describe('Domain ID'), }, },