GoDaddy

App · 17 actions

Find available domains, read domain details and manage GoDaddy DNS records.

Actions

ActionWhat it does
Add dns recordsAdd dns records.
Check availabilityCheck availability.
Check bulk availabilityCheck bulk availability.
Delete named dns recordsDelete named dns records.
Get agreementsGet agreements.
Get domainGet domain.
Get registration schemaGet registration schema.
List dns recordsList dns records.
List domainsList domains.
List tldsList tlds.
Replace dns recordsReplace dns records.
Replace named dns recordsReplace named dns records.
Replace typed dns recordsReplace typed dns records.
Resend registrant verificationResend registrant verification.
Suggest domainsSuggest domains.
Update domainUpdate domain.
Update domain contactsUpdate domain contacts.

Add dns records

Add dns records. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain whose DNS Records are to be augmented
PayloadpayloadlistRequired
The structured request, using the documented fields.

Outputs

API response.

datanull
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Check availability

Check availability. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain name whose availability is to be checked
CheckTypecheckTypetext
Optimize for time ('FAST') or accuracy ('FULL')One of: FAST, FULL, fast, full.
ForTransferforTransfertrue/false
Whether or not to include domains available for transfer. If set to True, checkType is ignored

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": {
    "available": false,
    "currency": "example",
    "definitive": false,
    "domain": "example",
    "period": 1,
    "price": 1
  },
  "has_more": false,
  "next_cursor": null
}

Check bulk availability

Check bulk availability. Returns one response page; the connected account determines access.

Inputs

CheckTypecheckTypetext
Optimize for time ('FAST') or accuracy ('FULL')One of: FAST, FULL, fast, full.
PayloadpayloadlistRequired
The structured request, using the documented fields.At most 500.

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": {
    "domains": []
  },
  "has_more": false,
  "next_cursor": null
}

Delete named dns records

Delete named dns records. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain whose DNS Records are to be deleted
TypetypetextRequired
DNS Record Type for which DNS Records are to be deletedOne of: A, AAAA, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT.
NamenametextRequired
DNS Record Name for which DNS Records are to be deleted

Outputs

API response.

datanull
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Get agreements

Get agreements. Returns one response page; the connected account determines access.

Inputs

TldstldslistRequired
list of TLDs whose legal agreements are to be retrieved
V1 privacyv1_privacytrue/falseRequired
Whether or not privacy has been requested
ForTransferforTransfertrue/false
Whether or not domain tranfer has been requested

Outputs

API response.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Get domain

Get domain. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain name whose details are to be retrieved

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": {
    "authCode": "example",
    "contactAdmin": {
      "addressMailing": {
        "address1": "example",
        "address2": "example",
        "city": "example",
        "country": "AC",
        "postalCode": "example",
        "state": "example"
      },
      "email": "example",
      "fax": "example",
      "jobTitle": "example",
      "nameFirst": "example",
      "nameLast": "example",
      "nameMiddle": "example",
      "organization": "example",
      "phone": "example"
    },
    "contactBilling": {
      "addressMailing": {
        "address1": "example",
        "address2": "example",
        "city": "example",
        "country": "AC",
        "postalCode": "example",
        "state": "example"
      },
      "email": "example",
      "fax": "example",
      "jobTitle": "example",
      "nameFirst": "example",
      "nameLast": "example",
      "nameMiddle": "example",
      "organization": "example",
      "phone": "example"
    },
    "contactRegistrant": {
      "addressMailing": {
        "address1": "example",
        "address2": "example",
        "city": "example",
        "country": "AC",
        "postalCode": "example",
        "state": "example"
      },
      "email": "example",
      "fax": "example",
      "jobTitle": "example",
      "nameFirst": "example",
      "nameLast": "example",
      "nameMiddle": "example",
      "organization": "example",
      "phone": "example"
    },
    "contactTech": {
      "addressMailing": {
        "address1": "example",
        "address2": "example",
        "city": "example",
        "country": "AC",
        "postalCode": "example",
        "state": "example"
      },
      "email": "example",
      "fax": "example",
      "jobTitle": "example",
      "nameFirst": "example",
      "nameLast": "example",
      "nameMiddle": "example",
      "organization": "example",
      "phone": "example"
    },
    "createdAt": "2026-01-01T00:00:00Z",
    "deletedAt": "2026-01-01T00:00:00Z",
    "domain": "example",
    "domainId": 1.0,
    "expirationProtected": false,
    "expires": "2026-01-01T00:00:00Z",
    "exposeRegistrantOrganization": false,
    "exposeWhois": false,
    "holdRegistrar": false,
    "locked": false,
    "nameServers": [],
    "privacy": false,
    "registrarCreatedAt": "example",
    "renewAuto": false,
    "renewDeadline": "2026-01-01T00:00:00Z",
    "status": "example",
    "subaccountId": "example",
    "transferAwayEligibleAt": "2026-01-01T00:00:00Z",
    "transferProtected": false,
    "verifications": {
      "domainName": {
        "status": "APPROVED"
      },
      "realName": {
        "status": "APPROVED"
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get registration schema

Get registration schema. Returns one response page; the connected account determines access.

Inputs

TldtldtextRequired
The Top-Level Domain whose schema should be retrieved

Outputs

API response.

dataobject
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": {
    "id": "example",
    "models": [],
    "properties": [],
    "required": []
  },
  "has_more": false,
  "next_cursor": null
}

List dns records

List dns records. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain whose DNS Records are to be retrieved
TypetypetextRequired
DNS Record Type for which DNS Records are to be retrievedOne of: A, AAAA, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT.
NamenametextRequired
DNS Record Name for which DNS Records are to be retrieved
Offsetoffsetnumber
Number of results to skip for pagination
Limitlimitnumber
Maximum number of items to return

Outputs

API response.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List domains

List domains. Returns one response page; the connected account determines access.

Inputs

Statusesstatuseslist
Only include results with `status` value in the specified setOne or more of: ACTIVE, AWAITING_CLAIM_ACK, AWAITING_DOCUMENT_AFTER_TRANSFER, AWAITING_DOCUMENT_AFTER_UPDATE_ACCOUNT, AWAITING_DOCUMENT_UPLOAD, AWAITING_FAILED_TRANSFER_WHOIS_PRIVACY, AWAITING_PAYMENT, AWAITING_RENEWAL_TRANSFER_IN_COMPLETE, AWAITING_TRANSFER_IN_ACK, AWAITING_TRANSFER_IN_AUTH, and 215 more.
StatusGroupsstatusGroupslist
Only include results with `status` value in any of the specified groupsOne or more of: INACTIVE, PRE_REGISTRATION, REDEMPTION, RENEWABLE, VERIFICATION_ICANN, VISIBLE.
Limitlimitnumber
Maximum number of domains to returnFrom 1 to 1000.
Markermarkertext
Marker Domain to use as the offset in results
Includesincludeslist
Optional details to be included in the responseOne or more of: authCode, contacts, nameServers.
ModifiedDatemodifiedDatetext
Only include results that have been modified since the specified date

Outputs

API response.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List tlds

List tlds. Returns one response page; the connected account determines access.

Inputs

None.

Outputs

API response.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Replace dns records

Replace dns records. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain whose DNS Records are to be replaced
PayloadpayloadlistRequired
The structured request, using the documented fields.

Outputs

API response.

datanull
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Replace named dns records

Replace named dns records. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain whose DNS Records are to be replaced
TypetypetextRequired
DNS Record Type for which DNS Records are to be replacedOne of: A, AAAA, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT.
NamenametextRequired
DNS Record Name for which DNS Records are to be replaced
PayloadpayloadlistRequired
The structured request, using the documented fields.

Outputs

API response.

datanull
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Replace typed dns records

Replace typed dns records. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain whose DNS Records are to be replaced
TypetypetextRequired
DNS Record Type for which DNS Records are to be replacedOne of: A, AAAA, CAA, CNAME, MX, NS, PTR, SOA, SRV, TXT.
PayloadpayloadlistRequired
The structured request, using the documented fields.

Outputs

API response.

datanull
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Resend registrant verification

Resend registrant verification. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain whose Contact E-mail should be verified.

Outputs

API response.

datanull
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Suggest domains

Suggest domains. Returns one response page; the connected account determines access.

Inputs

Queryquerytext
Domain name or set of keywords for which alternative domain names will be suggested
Countrycountrytext
Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many moreOne of: AC, AD, AE, AF, AG, AI, AL, AM, AO, AQ, and 234 more.
Citycitytext
Name of city to be used as a hint for target region
Sourcessourceslist
Sources to be queried - **CC_TLD** : Varies the TLD using Country Codes - **EXTENSION** : Varies the TLD - **KEYWORD_SPIN** : Identifies keywords and then rotates each one - **PREMIUM** : Includes variations with premium pricesOne or more of: CC_TLD, EXTENSION, KEYWORD_SPIN, PREMIUM, cctld, extension, keywordspin, premium.
Tldstldslist
Top-level domains to be included in suggestions NOTE: These are sample values, there are many more
LengthMaxlengthMaxnumber
Maximum length of second-level domain
LengthMinlengthMinnumber
Minimum length of second-level domain
Limitlimitnumber
Maximum number of suggestions to return
WaitMswaitMsnumber
Maximum amount of time, in milliseconds, to wait for responses If elapses, return the results compiled up to that point

Outputs

API response.

datalist
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Update domain

Update domain. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain whose details are to be updated
Lockedlockedtrue/false
Whether or not the domain should be locked to prevent transfers
NameServersnameServerslist
Fully-qualified domain names for Name Servers to associate with the domain
RenewAutorenewAutotrue/false
Whether or not the domain should be configured to automatically renew
SubaccountIdsubaccountIdtext
Reseller subaccount shopperid who can manage the domain
ExposeRegistrantOrganizationexposeRegistrantOrganizationtrue/false
Whether or not the domain registrant contact organization field should be shown in the WHOIS
ExposeWhoisexposeWhoistrue/false
Whether or not the domain contact details should be shown in the WHOIS
Consentconsentobject
Consent.

Outputs

API response.

datanull
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Update domain contacts

Update domain contacts. Returns one response page; the connected account determines access.

Inputs

DomaindomaintextRequired
Domain whose Contacts are to be updated.
ContactAdmincontactAdminobject
Contactadmin.
ContactBillingcontactBillingobject
Contactbilling.
ContactRegistrantcontactRegistrantobjectRequired
Contactregistrant.
ContactTechcontactTechobject
Contacttech.

Outputs

API response.

datanull
Data.
has_moretrue/false
Whether a continuation page is available.
next_cursortext
Continuation value, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

On this page