Skip to main content

Veracode API credentials file

Some Veracode products, such as the IDE plugins and extensions, require you to store your API credentials in a secure file called a Veracode API credentials file.

note

The Veracode API credentials file only supports HMAC credentials. OAuth Client credentials aren't supported.

You create the Veracode API credentials file on a Windows, macOS, Linux, or UNIX machine, and place the file in a specific directory on one or more machines where you use APIs or integrations. The integration, API wrapper, or command-line tool reads the file from this directory to access your credentials and authenticate securely with Veracode.

Alternatively, you can set your credentials as environment variables. Use either the Veracode API credentials file or environment variables, but not both.

Create an API credentials file on Windows​

Create the file on Windows to store your API credentials and, optionally, encrypt it for added security.

Before you begin:

  • Ensure you have created HMAC credentials.
  • Ensure you have added your API credentials to the [default] application profile. If you have a [greenlight] profile, delete it or rename it to [default].

To complete this task:

  1. In File Explorer, go to C:\Users\{username}, where username is your Windows user profile folder.

  2. Create a new folder named .veracode..

    Important

    The folder name must begin and end with a period (.). The second period ensures that the folder name begins with a period, but only the first period appears in the folder name.

  3. Open a text editor, such as Notepad, and add your API credentials to a new file in the following format:

    [default]
    veracode_api_key_id = <your HMAC ID>
    veracode_api_key_secret = <your HMAC Secret Key>

    The spaces around the equals signs (=) are optional.

  4. Select File > Save As.

  5. For File name, enter "credentials".

    note

    Include the quotation marks to prevent Notepad from adding a file extension.

  6. Select Save. If the file has an extension, such as TXT, open the file properties and remove the extension.

  7. Optionally, to restrict access to the file, in the file properties, select Encrypt contents to secure data in the Advanced Attributes window.

Create an API credentials file on macOS, Linux, or UNIX​

Create the file on macOS, Linux, or UNIX to store your API credentials and, optionally, restrict access to the file.

Before you begin:

  • Ensure you have created HMAC credentials.
  • Ensure you have added your API credentials to the [default] application profile. If you have a [greenlight] profile, delete it or rename it to [default].

To complete this task:

  1. On the command line, navigate to your home folder. For example, $HOME.

  2. To create the .veracode folder, run:

    $ mkdir .veracode

  3. Navigate to the .veracode folder. For example:

    $ cd .veracode
    note

    On macOS, the .veracode folder is hidden by default because its name starts with a period.

  4. To create the credentials file, run:

    $ touch credentials

  5. Open Finder to .veracode.

  6. Open the credentials file in a text editor.

  7. Copy the following text and paste it into the credentials file:

    [default]
    veracode_api_key_id = <your HMAC ID>
    veracode_api_key_secret = <your HMAC Secret Key>

    The spaces around the equals signs (=) are optional.

  8. Replace the values with your credentials.

  9. Save the credentials file.

  10. Optionally, to restrict access to the credentials file, run:

    chmod 600 ~/.veracode/credentials
Last updated on