Skip to main content
GoDaddy logo

​
Overview

Add GoDaddy to any ModuleX agent or workflow. Domain registration, availability checking, and management via the GoDaddy REST API (api.godaddy.com/v1).
Categories: Cloud Infrastructure · Domains · Infrastructure · Web Hosting · Auth: GoDaddy API Key + Secret · Actions: 5

​
Authentication

​
GoDaddy API Key + Secret

Authenticate using a GoDaddy API key and secret pair. The Authorization header is built as ‘sso-key <key>:<secret>’.

​
Required Credentials

FieldDescriptionRequiredFormat
API KeyYour GoDaddy API Key from developer.godaddy.comYesxxxxxxxxxxxxxxxx
API SecretYour GoDaddy API Secret from developer.godaddy.comYesxxxxxxxxxxxxxxxxxxxxxxxx
API URLGoDaddy API base URL. Use https://api.godaddy.com for production or https://api.ote-godaddy.com for the test environmentYeshttps://api.godaddy.com

​
Available Actions

​
Parameters

​
domain
string
required
The domain name to check availability for (e.g. example.com)
​
check_type
string
Optimize for time (FAST) or accuracy (FULL). Allowed values: FAST, FULL
​
for_transfer
boolean
Whether to include domains available for transfer. If true, check_type is ignored

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "available": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Available"
    },
    "domain": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Domain"
    },
    "definitive": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Definitive"
    },
    "price": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Price"
    },
    "currency": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Currency"
    },
    "period": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Period"
    }
  },
  "required": [
    "success"
  ],
  "title": "CheckDomainAvailabilityOutput",
  "type": "object"
}

​
Parameters

​
statuses
array
Filter by status. Array of strings: ACTIVE, CANCELLED, etc.
​
status_groups
array
Filter by status group. Array of strings: VISIBLE, INACTIVE, RENEWABLE, etc.
​
limit
integer
Maximum number of domains to return
​
marker
string
Marker domain to use as the offset in results
​
includes
array
Optional details to include: authCode, contacts, nameServers
​
modified_date
string
Only include results modified since this date (ISO 8601 format)

​
Response

{
  "$defs": {
    "DomainSummary": {
      "additionalProperties": false,
      "description": "A domain summary object from the list domains endpoint.",
      "properties": {
        "domain": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Domain"
        },
        "status": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Status"
        },
        "expires": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Expires"
        },
        "created_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Created At"
        },
        "renewable": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Renewable"
        }
      },
      "title": "DomainSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "domains": {
      "items": {
        "$ref": "#/$defs/DomainSummary"
      },
      "title": "Domains",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListDomainsOutput",
  "type": "object"
}

​
Response

{
  "$defs": {
    "TldInfo": {
      "additionalProperties": false,
      "description": "A TLD entry from the list TLDs endpoint.",
      "properties": {
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Type"
        }
      },
      "title": "TldInfo",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "tlds": {
      "items": {
        "$ref": "#/$defs/TldInfo"
      },
      "title": "Tlds",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListTldsOptionsOutput",
  "type": "object"
}

​
Parameters

​
domain
string
required
The domain name to renew (e.g. example.com)
​
period
integer
Number of years to extend the domain (1-10). Defaults to original purchase period when omitted

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "order_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Order Id"
    },
    "item_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Item Count"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    },
    "currency": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Currency"
    }
  },
  "required": [
    "success"
  ],
  "title": "RenewDomainOutput",
  "type": "object"
}

​
Parameters

​
query
string
required
Domain name or keywords for which alternative domain names will be suggested
​
country
string
Two-letter ISO country code as a hint for target region
​
city
string
City name as a hint for target region
​
sources
array
Sources to query: CC_TLD, EXTENSION, KEYWORD_SPIN, PREMIUM
​
tlds
array
Top-level domains to include in suggestions (e.g. com, net, org)
​
length_max
integer
Maximum length of second-level domain
​
length_min
integer
Minimum length of second-level domain
​
limit
integer
Maximum number of suggestions to return
​
wait_ms
integer
Maximum time in milliseconds to wait for responses

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "suggestions": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Suggestions",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "SuggestDomainsOutput",
  "type": "object"
}

​
Limits & Quotas

  • Production API: 60 requests per minute per API key (per GoDaddy developer documentation).
  • OTE (test) API: Lower rate limits; intended for development only.
  • Renewal actions incur actual charges on the account.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

Amazon Web Services

Azure Storage

Cloudflare