Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 2. Creating the API token in automation hub

Before you can interact with automation hub by uploading or downloading collections, you must create an API token. The automation hub API token authenticates your ansible-galaxy client to the Red Hat automation hub server.

Note

automation hub does not support basic authentication or authenticating through service accounts. You must authenticate using token management.

Your method for creating the API token differs according to the type of automation hub that you are using:

2.1. Creating the offline token in automation hub

In automation hub, you can create an offline token using Token management. The offline token is a secret token used to protect your content.

Procedure

  1. Navigate to Ansible Automation Platform on the Red Hat Hybrid Cloud Console.
  2. From the navigation panel, select Automation Hub Connect to Hub.
  3. Under Offline token, click Load Token.
  4. Click the Copy to clipboard icon to copy the offline token.
  5. Paste the token into a file and store in a secure location.
Important

The offline token is a secret token used to protect your content. Store your token in a secure location.

The offline token is now available for configuring automation hub as your default collections server or for uploading collections by using the ansible-galaxy command line tool.

Note

Your offline token expires after 30 days of inactivity. For more on obtaining a new offline token, see Keeping your offline token active.

2.2. Creating the API token in private automation hub

In private automation hub, you can create an API token using API token management. The API token is a secret token used to protect your content.

Prerequisites

  • Valid subscription credentials for Red Hat Ansible Automation Platform.

Procedure

  1. Log in to your private automation hub.
  2. From the navigation panel, select Collections API token.
  3. Click Load Token.
  4. To copy the API token, click the Copy to clipboard icon.
  5. Paste the API token into a file and store in a secure location.
Important

The API token is a secret token used to protect your content. Store your API token in a secure location.

The API token is now available for configuring automation hub as your default collections server or uploading collections using the ansible-galaxy command line tool.

Note

The API token does not expire.

2.3. Keeping your offline token active

Offline tokens expire after 30 days of inactivity. You can keep your offline token from expiring by keeping it active.

Keeping an offline token active is useful when an application performs an action on behalf of the user; for example, this allows the application to perform a routine data backup when the user is offline.

Note

If your offline token expires, you must obtain a new one.

Procedure

  • Run the following command to prevent your token from expiring: 

    curl https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token -d grant_type=refresh_token -d client_id="cloud-services" -d refresh_token="{{ user_token }}" --fail --silent --show-error --output /dev/null
    Copy to Clipboard
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat