View as Markdown
GoDaddy icon

GoDaddy ACTION

Suggest Domains

Suggest domains based on the given criteria. 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 Suggest Domains 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-suggest-domains",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    godaddy: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    country: "Country",
  },
})

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.

Suggest Domains inputs
Property Type Description
query Query string
Domain name or set of keywords for which alternative domain names will be suggested
Required
country Country string
Two-letter ISO country code to be used as a hint for target region
Optional
city City string
Name of city to be used as a hint for target region
Optional
sources Sources string[]
Sources to be queried
Optional
tlds TLDs string[]
Top-level domains to be included in suggestions
Optional Dynamic
lengthMax Length Max integer
Maximum length of second-level domain
Optional
lengthMin Length Min integer
Minimum length of second-level domain
Optional
limit Limit integer
Maximum number of suggestions to return
Optional
waitMs Wait Ms integer
Maximum amount of time, in milliseconds, to wait for responses. If elapses, return the results compiled up to that point
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-suggest-domains
Version
0.0.2
App
GoDaddy
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes