View as Markdown
GoDaddy icon

GoDaddy ACTION

Check Domain Availability

Check the availability of a domain. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's GoDaddy account once, then configure and run Check Domain Availability from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "godaddy-check-domain-availability",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    godaddy: { authProvisionId: "apn_xxxxxxx" },
    domain: "Domain",
    checkType: "Check Type",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Check Domain Availability inputs
Property Type Description
domain Domain string
The domain to check availability for
Required
checkType Check Type string
Optimize for time ('FAST') or accuracy ('FULL')
Optional
forTransfer For Transfer boolean
Whether or not to include domains available for transfer. If set to true, checkType is ignored
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
godaddy-check-domain-availability
Version
0.0.2
App
GoDaddy
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes