Support
AuthenticateAuthenticate

How to Authenticate

View as Markdown

Step-by-step instructions for generating a Personal Access Token (PAT) or classic developer key to authenticate GoDaddy API calls.

Overview

GoDaddy API uses authentication to ensure that only authorized users can access the API. The two authentication methods are using a Personal Access Token (PAT) or the Classic Developer Key. PATs are required for all v3 Domains APIs. The following article provides step-by-step instructions for generating a PAT or classic developer key to authenticate GoDaddy API calls. Go to About Authentication to learn more about the different authentication methods and their scopes.

Generate, use, and manage tokens

The following sections explain how to generate, use, and manage PATs or classic developer keys to authenticate GoDaddy API calls.

Generate a token

The following steps explain how to generate a PAT to authenticate GoDaddy API calls.

  1. Sign in to the Personal Access Token page.
  2. Click + Generate Token.
  3. In the Generate personal access token dialog, complete the following fields:
    FieldDescriptionNote
    NameName for the token.
    ExpirationNumber of days until the token expires.
    ScopesScopes for the token.Go to PAT scopes to see the available scopes.
  4. Click Generate Token.

Store your token securely

After generating the token, it displays once. You can't retrieve it again from the Personal Access Token page and you should store it in secure storage immediately. Don't commit it to source control, check it into a repo, or paste it into chat.

  1. In the Copy your new token dialog, click the copy icon.
  2. Save the token in a password manager, secrets manager, or your application's secure credential store.
  3. Load the token at runtime when you need it as a local script in a shell session or as a secret in a secrets store or CI/CD environment variable:
export GODADDY_PAT="<GODADDY_PAT>"

Don't treat export as storage

export GODADDY_PAT=... makes the token available to the current shell — it is not a secure place to keep credentials long term. Store the value in a secrets manager first, then export or inject it only when running a command or starting your app.

Use a token

The following steps explain how to use a PAT to authenticate GoDaddy API calls.

  • Add the header to every request:
Authorization: Bearer ${GODADDY_PAT}

Revoke a token

The following steps explain how to revoke a PAT.

  1. Sign in to the Personal Access Token page.
  2. Next to the token you want to revoke, click the trash icon.
  3. In the Revoke token? dialog, click Revoke Token.

Agent & Automation Notes

PermissionsAny account
ScopesNot applicable — this page is credential setup
Rate limitPAT creation: interactive UI, not rate-limited.
IdempotentYes
DestructiveNo
On failurePAT reveals once at creation — if lost, revoke and regenerate. Revocation is instant across all edges.

Last updated on

How is this guide?

On this page