How to Authenticate

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. Select Generate Token.
3. On the Generate Personal Access Token page, complete the following fields:

   Field	Description	Note
   Token Name	Name for the token.
   Expires After	How long the token stays valid: 7, 30, 60, or 90 days, or 1 year.
   Permissions	Scopes for the token.	Go to PAT scopes to see the available scopes.

4. Select Create 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 Personal Access Token Created dialog, select Copy Token.
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>"

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}

Clone a token

The following steps explain how to clone an existing PAT.

1. Sign in to the Personal Access Token page.
2. Next to the token you want to clone, select the actions menu (⋯), then select Clone.
3. On the Generate Personal Access Token page, change the selected scopes if needed.
4. Select Create Token.
5. Save the new token in a password manager, secrets manager, or your application's secure credential store.

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, select the actions menu (⋯), then select Revoke.
3. In the Revoke token? dialog, select Revoke Token.