Configure an API Credentials File on macOS or Linux

Getting Started with Veracode

You can configure a Veracode API credentials file on macOS or Linux and, optionally, run a command to restrict access to the file.

Before configuring a Veracode API credentials file:
  • You have generated Veracode API credentials.
  • Depending on your Veracode integration, you have added your Veracode API credentials to the [default] application profile. If you have an existing [greenlight] profile, delete it or rename it to [default].
To configure the Veracode API credentials on macOS, Linux, or UNIX:
  1. On the command line, navigate to the folder for your user name. For example, $HOME.
  2. Run the following command to create the .veracode folder: $ mkdir .veracode
  3. Navigate to the .veracode folder. For example: $ cd .veracode
    Note: macOS immediately hides the .veracode folder because the folder name begins with a period.
  4. Run the following touch command to create the credentials file: $ touch credentials
  5. Open the Finder to .veracode.
  6. Double-click the credentials file to open it in a text editor.
  7. Copy the following text and paste it into the credentials file.
    veracode_api_key_id = Your API ID
    veracode_api_key_secret = Your API key               

    The spaces around the equals sign (=) are not required.

  8. Replace the values with your Veracode API credentials.
  9. Save the credentials file.
  10. Optionally, you can run the following command to restrict access to the credentials file: chmod 600 ~/.veracode/credentials