Skip to main content
Glama

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
NameRequiredDescriptionDefault
domainidYesDomain ID

Implementation Reference

  • 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) }],
            };
        }
    );
  • Zod input schema validation for the tool, requiring a numeric domainid.
            domainid: z.number().describe('Domain ID'),
        },
    },

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/scarecr0w12/whmcs-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server