Skip to main content

Find the agent keys

Agent keys are common to all agents in an organization. They are values that represent and identify the agents as well as the organization being accessed.

Important

If you download a YAML configuration file from Contrast instead of using the configuration that an agent wizard creates (select Add new in the top right, select Live Application, and go to the Configuration step), the file is pre-populated with your agent keys.

If you create your own YAML file, you'll need to add the keys yourself.

Preferred keys

The preferred keys to use when installing agents are:

  • Agent key name

    This value is the same as the API__user_name. It is embedded in the Agent token. In most cases, you don't need to specify it if you are using the Agent token.

  • Agent token

    The agent token replaces these legacy keys: Agent service key, Agent username, API key, and Contrast URL.

The agent versions that support the agent token are:

  • Java 6.10.1 or later

  • .NET Framework 51.0.40 or later

  • .NET Core 4.2.22 or later

  • Node.js 5.15.0 or later

  • Python 8.6.0 or later

  • PHP 1.34.0 or later

  • Go 6.11.0 or later

Legacy keys

For older agents, these keys are required when installing agents:

  • Agent key name (API__user_name)

  • Agent service key

  • API key

    This API key is for all agents. For the API key to use with custom scripts, use the API key under User settings.

  • Contrast URL

Steps

  1. Select User name > Organization settings in the top right corner.

  2. Select Agent keys.

    Image shows the Agent keys under Organization settings.

    Note

    If you don't see the keys on this page, it may mean that a license has not been applied to your organization. Contact Support for help with this.

  3. If you are using an older agent, select Legacy agent keys.

    • The Contrast URL is https://<environment>-agents.contrastsecurity.com/Contrast, or the URL of your on-premises or private cloud instance.

    • You can Rotate agent keys to generate new keys if your credentials have been compromised.

      Important

      Rotating agent service keys will take all agents offline. Your applications will still function, but data will not be sent to Contrast. To begin using the new credentials, reconfigure the agents and restart your applications. You can use a credential management system to coordinate this change among your systems.

In this section: