Categorygithub.com/kryptoslogic/godaddy-domainclient
repositorypackage
0.1.0
Repository: https://github.com/kryptoslogic/godaddy-domainclient.git
Documentation: pkg.go.dev

# README

Go API client for godaddy

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version:
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./godaddy"

By default this library uses the sandbox API, if you wish to use the production API set the Configuration BasePath to https://api.godaddy.com/

An example of the library:

var apiConfig = godaddy.NewConfiguration()
// Test
//apiConfig.BasePath = "https://api.ote-godaddy.com/"

// Prod
apiConfig.BasePath = "https://api.godaddy.com/"

// Set auth
var authString = fmt.Sprintf("sso-key %s:%s", "apiKeyHere", "apiSecretHere")
apiConfig.AddDefaultHeader("Authorization", authString)

var apiClient = godaddy.NewAPIClient(apiConfig)

A more complete example can be found here

Documentation for API Endpoints

All URIs are relative to https://api.ote-godaddy.com

ClassMethodHTTP requestDescription
V1ApiAvailableGet /v1/domains/availableDetermine whether or not the specified domain is available for purchase
V1ApiAvailableBulkPost /v1/domains/availableDetermine whether or not the specified domains are available for purchase
V1ApiCancelDelete /v1/domains/{domain}Cancel a purchased domain
V1ApiCancelPrivacyDelete /v1/domains/{domain}/privacySubmit a privacy cancellation request for the given domain
V1ApiContactsValidatePost /v1/domains/contacts/validateValidate the request body using the Domain Contact Validation Schema for specified domains.
V1ApiGetGet /v1/domains/{domain}Retrieve details for the specified Domain
V1ApiGetAgreementGet /v1/domains/agreementsRetrieve the legal agreement(s) required to purchase the specified TLD and add-ons
V1ApiListGet /v1/domainsRetrieve a list of Domains for the specified Shopper
V1ApiPurchasePost /v1/domains/purchasePurchase and register the specified Domain
V1ApiPurchasePrivacyPost /v1/domains/{domain}/privacy/purchasePurchase privacy for a specified domain
V1ApiRecordAddPatch /v1/domains/{domain}/recordsAdd the specified DNS Records to the specified Domain
V1ApiRecordGetGet /v1/domains/{domain}/records/{type}/{name}Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name
V1ApiRecordReplacePut /v1/domains/{domain}/recordsReplace all DNS Records for the specified Domain
V1ApiRecordReplaceTypePut /v1/domains/{domain}/records/{type}Replace all DNS Records for the specified Domain with the specified Type
V1ApiRecordReplaceTypeNamePut /v1/domains/{domain}/records/{type}/{name}Replace all DNS Records for the specified Domain with the specified Type and Name
V1ApiRenewPost /v1/domains/{domain}/renewRenew the specified Domain
V1ApiSchemaGet /v1/domains/purchase/schema/{tld}Retrieve the schema to be submitted when registering a Domain for the specified TLD
V1ApiSuggestGet /v1/domains/suggestSuggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history
V1ApiTldsGet /v1/domains/tldsRetrieves a list of TLDs supported and enabled for sale
V1ApiTransferInPost /v1/domains/{domain}/transferPurchase and start or restart transfer process
V1ApiUpdatePatch /v1/domains/{domain}Update details for the specified Domain
V1ApiUpdateContactsPatch /v1/domains/{domain}/contactsUpdate domain
V1ApiValidatePost /v1/domains/purchase/validateValidate the request body using the Domain Purchase Schema for the specified TLD
V1ApiVerifyEmailPost /v1/domains/{domain}/verifyRegistrantEmailRe-send Contact E-mail Verification for specified Domain

Documentation For Models

Author