Skip to main content

Find the agent keys


If you download the YAML configuration file from Contrast (select Add new in the top right) the file is pre-populated with your agent keys.

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

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.

All these keys are required when installing agents:

  • Agent username

  • 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


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

  2. Select Agent to see the values for agent keys.

    Image shows the Agent keys

    The Contrast URL is, or the URL of your on-premises or private cloud instance.


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

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


    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.