Skip to main content

Local scan engine environment variables

Use these environment variables with the local Scan engine:

Variable

Required?

Description

CONTRAST__API__URL

Yes

The address of the Contrast installation where you want to report scan results. The URL should include /api/sast at the end of the URL.

CONTRAST__API__USER_NAME

Yes

User name for the Contrast user account (in most cases, your login ID)

CONTRAST__API__API_KEY

Yes

Contrast API key

CONTRAST__API__SERVICE_KEY

Yes

Contrast service key

CONTRAST__API__ORGANIZATION

Yes

Contrast organization ID

CONTRAST__API__PROXY__ENABLE

No

Enables proxy settings

CONTRAST__API__PROXY__URL

Yes, if proxy settings are enabled

The URL for the proxy server (for example, http://host:port)

CONTRAST__API__PROXY__TYPE

Yes, if proxy settings are enabled

The proxy server type (for example, BASIC)

CONTRAST__API__PROXY__USERNAME

No

Username for the proxy server

CONTRAST__API__PROXY__PASSWORD

No

Password for the proxy server