Struct VeracodeClient

Source

pub struct VeracodeClient { /* private fields */ }

Expand description

Core Veracode API client.

This struct provides the foundational HTTP client with HMAC authentication for making requests to any Veracode API endpoint.

Implementations§

Source §

impl VeracodeClient

Application-specific methods that build on the core client.

Source

pub async fn get_applications( &self, query: Option<ApplicationQuery>, ) -> Result<ApplicationsResponse, VeracodeError>

Get all applications with optional filtering.

§Arguments

query - Optional query parameters to filter the results

§Returns

A Result containing an ApplicationsResponse with the list of applications.

§Errors

Returns an error if the API request fails, the response cannot be parsed, or validation of pagination parameters fails.

§Security

Pagination parameters are automatically validated and normalized to prevent resource exhaustion attacks.

Source

pub async fn get_application( &self, guid: &AppGuid, ) -> Result<Application, VeracodeError>

Get a specific application by its GUID.

§Arguments

guid - The GUID of the application to retrieve

§Returns

A Result containing the Application details.

§Errors

Returns an error if the API request fails, the response cannot be parsed, or the application is not found.

§Security

This method validates the GUID format to prevent URL path injection attacks.

Source

pub async fn create_application( &self, request: &CreateApplicationRequest, ) -> Result<Application, VeracodeError>

Create a new application.

§Arguments

request - The application creation request containing profile information

§Returns

A Result containing the created Application.

§Errors

Returns an error if the API request fails, the request cannot be serialized, or the response cannot be parsed.

Source

pub async fn update_application( &self, guid: &AppGuid, request: &UpdateApplicationRequest, ) -> Result<Application, VeracodeError>

Update an existing application.

§Arguments

guid - The GUID of the application to update
request - The update request containing the new profile information

§Returns

A Result containing the updated Application.

§Errors

Returns an error if the API request fails, the request cannot be serialized, or the response cannot be parsed.

§Security

This method validates the GUID format to prevent URL path injection attacks.

Source

pub async fn delete_application( &self, guid: &AppGuid, ) -> Result<(), VeracodeError>

Delete an application.

§Arguments

guid - The GUID of the application to delete

§Returns

A Result indicating success or failure.

§Errors

Returns an error if the API request fails or the application is not found.

§Security

This method validates the GUID format to prevent URL path injection attacks.

Source

pub async fn get_non_compliant_applications( &self, ) -> Result<Vec<Application>, VeracodeError>

Get applications that failed policy compliance.

§Returns

A Result containing a Vec<Application> of non-compliant applications.

§Errors

Returns an error if the API request fails or the response cannot be parsed.

Source

pub async fn get_applications_modified_after( &self, date: &str, ) -> Result<Vec<Application>, VeracodeError>

Get applications modified after a specific date.

§Arguments

date - ISO 8601 formatted date string

§Returns

A Result containing a Vec<Application> of applications modified after the date.

§Errors

Returns an error if the API request fails or the response cannot be parsed.

Source

pub async fn search_applications_by_name( &self, name: &str, ) -> Result<Vec<Application>, VeracodeError>

Search applications by name.

§Arguments

name - The name to search for (partial matches are supported)

§Returns

A Result containing a Vec<Application> of applications matching the name.

§Errors

Returns an error if the API request fails or the response cannot be parsed.

Source

pub async fn get_all_applications( &self, ) -> Result<Vec<Application>, VeracodeError>

Get all applications with automatic pagination.

§Returns

A Result containing a Vec<Application> of all applications.

§Errors

Returns an error if any API request fails or responses cannot be parsed.

Source

pub async fn get_application_by_name( &self, name: &str, ) -> Result<Option<Application>, VeracodeError>

Get application by name (exact match).

§Arguments

name - The exact name of the application to find

§Returns

A Result containing an Option<Application> if found.

§Errors

Returns an error if the API request fails or the response cannot be parsed.

Source

pub async fn application_exists_by_name( &self, name: &str, ) -> Result<bool, VeracodeError>

Check if application exists by name.

§Arguments

name - The name of the application to check

§Returns

A Result containing a boolean indicating if the application exists.

§Errors

Returns an error if the API request fails or the response cannot be parsed.

Source

pub async fn get_app_id_from_guid( &self, guid: &AppGuid, ) -> Result<String, VeracodeError>

Get numeric app_id from application GUID.

This is needed for XML API operations that require numeric IDs.

§Arguments

guid - The application GUID

§Returns

A Result containing the numeric app_id as a string.

§Errors

Returns an error if the API request fails, the application is not found, or the response cannot be parsed.

Source

pub async fn create_application_if_not_exists( &self, name: &str, business_criticality: BusinessCriticality, description: Option<String>, team_names: Option<Vec<String>>, repo_url: Option<String>, custom_kms_alias: Option<String>, ) -> Result<Application, VeracodeError>

Create application if it doesn’t exist, or return existing application.

This method implements the “check and create” pattern commonly needed for automated workflows. It intelligently updates missing fields on existing applications without overriding any existing values.

§Behavior

If application doesn’t exist: Creates it with all provided parameters
If application exists:
- Updates repo_url if current value is None/empty and parameter is provided
- Updates description if current value is None/empty and parameter is provided
- Never modifies business_criticality or teams on existing applications
- All other existing profile settings are preserved

This “fill in blanks” strategy ensures safe automation without overriding intentional configuration changes made through other workflows.

§Arguments

name - The name of the application
business_criticality - Business criticality level (required for creation, ignored for existing apps)
description - Optional description (sets on creation, updates if missing on existing apps)
team_names - Optional list of team names (sets on creation, ignored for existing apps)
repo_url - Optional repository URL (sets on creation, updates if missing on existing apps)
custom_kms_alias - Optional KMS alias for encryption

§Returns

A Result containing the application (existing, updated, or newly created).

§Errors

Returns an error if the API request fails, validation fails, team lookup fails, or the response cannot be parsed.

§Examples

// First call: Creates application with repo_url
let app = client.create_application_if_not_exists(
    "My Application",
    BusinessCriticality::High,
    Some("My app description".to_string()),
    None,
    Some("https://github.com/user/repo".to_string()),
    None,
).await?;

// Second call: Returns existing app, no updates (all fields populated)
let same_app = client.create_application_if_not_exists(
    "My Application",
    BusinessCriticality::Medium, // Ignored - won't change existing HIGH
    Some("Different description".to_string()), // Ignored - existing has value
    None,
    Some("https://github.com/user/repo".to_string()), // Ignored - existing has value
    None,
).await?;

// Application created without repo_url, then updated later
let app_v1 = client.create_application_if_not_exists(
    "Another App",
    BusinessCriticality::Medium,
    None,
    None,
    None, // No repo_url initially
    None,
).await?;

// Later: Adds repo_url to existing application (because it was missing)
let app_v2 = client.create_application_if_not_exists(
    "Another App",
    BusinessCriticality::High, // Ignored - won't change
    Some("Adding description".to_string()), // Updates (was None)
    None,
    Some("https://github.com/user/another".to_string()), // Updates (was None)
    None,
).await?;

Source

pub async fn create_application_if_not_exists_with_team_guids( &self, name: &str, business_criticality: BusinessCriticality, description: Option<String>, team_guids: Option<Vec<String>>, ) -> Result<Application, VeracodeError>

Create application if it doesn’t exist, or return existing application (with team GUIDs).

This method allows specifying teams by their GUID, which is the preferred approach for programmatic application creation.

§Arguments

name - The name of the application
business_criticality - Business criticality level (required for creation)
description - Optional description for new applications
team_guids - Optional list of team GUIDs to assign to the application

§Returns

A Result containing the application (existing or newly created).

§Errors

Returns an error if the API request fails, validation fails, or the response cannot be parsed.

Source

pub async fn create_application_if_not_exists_simple( &self, name: &str, business_criticality: BusinessCriticality, description: Option<String>, ) -> Result<Application, VeracodeError>

Create application if it doesn’t exist, or return existing application (without teams).

This is a convenience method that maintains backward compatibility for callers that don’t need to specify teams.

§Arguments

name - The name of the application
business_criticality - Business criticality level (required for creation)
description - Optional description for new applications

§Returns

A Result containing the application (existing or newly created).

§Errors

Returns an error if the API request fails, validation fails, or the response cannot be parsed.

Source

pub async fn enable_application_encryption( &self, app_guid: &AppGuid, kms_alias: &str, ) -> Result<Application, VeracodeError>

Enable Customer Managed Encryption Key (CMEK) on an application

This method updates an existing application to use a customer-managed encryption key. The KMS alias must be properly formatted and the key must be accessible to Veracode.

§Arguments

app_guid - The GUID of the application to enable encryption on
kms_alias - The AWS KMS alias to use for encryption (must start with “alias/”)

§Returns

A Result containing the updated application or an error.

§Errors

Returns an error if the KMS alias format is invalid, the API request fails, the application is not found, or the response cannot be parsed.

§Examples

let config = VeracodeConfig::from_arc_credentials(
    Arc::new(SecretString::from("api_id")),
    Arc::new(SecretString::from("api_key"))
);
let client = VeracodeClient::new(config)?;
let guid = AppGuid::new("550e8400-e29b-41d4-a716-446655440000")?;

let app = client.enable_application_encryption(
    &guid,
    "alias/my-encryption-key"
).await?;

Source

pub async fn change_encryption_key( &self, app_guid: &AppGuid, new_kms_alias: &str, ) -> Result<Application, VeracodeError>

Change the encryption key for an application with CMEK enabled

This method updates the KMS alias used for encrypting an application’s data. The application must already have CMEK enabled.

§Arguments

app_guid - The GUID of the application to update
new_kms_alias - The new AWS KMS alias to use for encryption

§Returns

A Result containing the updated application or an error.

§Errors

Returns an error if the KMS alias format is invalid, the API request fails, the application is not found, or the response cannot be parsed.

Source

pub async fn get_application_encryption_status( &self, app_guid: &AppGuid, ) -> Result<Option<String>, VeracodeError>

Get the encryption status of an application

This method retrieves the current CMEK configuration for an application.

§Arguments

app_guid - The GUID of the application to check

§Returns

A Result containing the KMS alias if CMEK is enabled, None if disabled, or an error.

§Errors

Returns an error if the API request fails, the application is not found, or the response cannot be parsed.

Source §

impl VeracodeClient

Source

pub fn new(config: VeracodeConfig) -> Result<Self, VeracodeError>

Create a new Veracode API client.

§Arguments

config - Configuration containing API credentials and settings

§Returns

A new VeracodeClient instance ready to make API calls.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub fn base_url(&self) -> &str

Get the base URL for API requests.

Source

pub fn config(&self) -> &VeracodeConfig

Get access to the configuration

Source

pub fn client(&self) -> &Client

Get access to the underlying reqwest client

Source

pub fn generate_auth_header( &self, method: &str, url: &str, ) -> Result<String, VeracodeError>

Generate authorization header for HMAC authentication

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn get( &self, endpoint: &str, query_params: Option<&[(String, String)]>, ) -> Result<Response, VeracodeError>

Make a GET request to the specified endpoint.

§Arguments

endpoint - The API endpoint path (e.g., “/appsec/v1/applications”)
query_params - Optional query parameters as key-value pairs

§Returns

A Result containing the HTTP response.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn post<T: Serialize>( &self, endpoint: &str, body: Option<&T>, ) -> Result<Response, VeracodeError>

Make a POST request to the specified endpoint.

§Arguments

endpoint - The API endpoint path (e.g., “/appsec/v1/applications”)
body - Optional request body that implements Serialize

§Returns

A Result containing the HTTP response.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn put<T: Serialize>( &self, endpoint: &str, body: Option<&T>, ) -> Result<Response, VeracodeError>

Make a PUT request to the specified endpoint.

§Arguments

endpoint - The API endpoint path (e.g., “/appsec/v1/applications/guid”)
body - Optional request body that implements Serialize

§Returns

A Result containing the HTTP response.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn delete(&self, endpoint: &str) -> Result<Response, VeracodeError>

Make a DELETE request to the specified endpoint.

§Arguments

endpoint - The API endpoint path (e.g., “/appsec/v1/applications/guid”)

§Returns

A Result containing the HTTP response.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn handle_response( response: Response, context: &str, ) -> Result<Response, VeracodeError>

Helper method to handle common response processing.

Checks if the response is successful and returns an error if not.

§Arguments

response - The HTTP response to check
context - A description of the operation being performed (e.g., “get application”)

§Returns

A Result containing the response if successful, or an error if not.

§Error Context

This method enhances error messages with context about the failed operation to improve debugging and user experience.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn get_with_query( &self, endpoint: &str, query_params: Option<Vec<(String, String)>>, ) -> Result<Response, VeracodeError>

Make a GET request with full URL construction and query parameter handling.

This is a higher-level method that builds the full URL and handles query parameters.

§Arguments

endpoint - The API endpoint path
query_params - Optional query parameters

§Returns

A Result containing the HTTP response, pre-processed for success/failure.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn post_with_response<T: Serialize>( &self, endpoint: &str, body: Option<&T>, ) -> Result<Response, VeracodeError>

Make a POST request with automatic response handling.

§Arguments

endpoint - The API endpoint path
body - Optional request body

§Returns

A Result containing the HTTP response, pre-processed for success/failure.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn put_with_response<T: Serialize>( &self, endpoint: &str, body: Option<&T>, ) -> Result<Response, VeracodeError>

Make a PUT request with automatic response handling.

§Arguments

endpoint - The API endpoint path
body - Optional request body

§Returns

A Result containing the HTTP response, pre-processed for success/failure.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn delete_with_response( &self, endpoint: &str, ) -> Result<Response, VeracodeError>

Make a DELETE request with automatic response handling.

§Arguments

endpoint - The API endpoint path

§Returns

A Result containing the HTTP response, pre-processed for success/failure.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn get_paginated( &self, endpoint: &str, base_query_params: Option<Vec<(String, String)>>, page_size: Option<u32>, ) -> Result<String, VeracodeError>

Make paginated GET requests to collect all results.

This method automatically handles pagination by making multiple requests and combining all results into a single response.

§Arguments

endpoint - The API endpoint path
base_query_params - Base query parameters (non-pagination)
page_size - Number of items per page (default: 500)

§Returns

A Result containing all paginated results as a single response body string.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn get_with_params( &self, endpoint: &str, params: &[(&str, &str)], ) -> Result<Response, VeracodeError>

Make a GET request with query parameters

§Arguments

endpoint - The API endpoint to call
params - Query parameters as a slice of tuples

§Returns

A Result containing the response or an error.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn post_form( &self, endpoint: &str, params: &[(&str, &str)], ) -> Result<Response, VeracodeError>

Make a POST request with form data

§Arguments

endpoint - The API endpoint to call
params - Form parameters as a slice of tuples

§Returns

A Result containing the response or an error.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn upload_file_multipart( &self, endpoint: &str, params: HashMap<&str, &str>, file_field_name: &str, filename: &str, file_data: Vec<u8>, ) -> Result<Response, VeracodeError>

Upload a file using multipart form data

§Arguments

endpoint - The API endpoint to call
params - Additional form parameters
file_field_name - Name of the file field
filename - Name of the file
file_data - File data as bytes

§Returns

A Result containing the response or an error.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn upload_file_multipart_put( &self, url: &str, file_field_name: &str, filename: &str, file_data: Vec<u8>, additional_headers: Option<HashMap<&str, &str>>, ) -> Result<Response, VeracodeError>

Upload a file using multipart form data with PUT method (for pipeline scans)

§Arguments

url - The full URL to upload to
file_field_name - Name of the file field
filename - Name of the file
file_data - File data as bytes
additional_headers - Additional headers to include

§Returns

A Result containing the response or an error.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn upload_file_with_query_params( &self, endpoint: &str, query_params: &[(&str, &str)], file_field_name: &str, filename: &str, file_data: Vec<u8>, ) -> Result<Response, VeracodeError>

Upload a file with query parameters (like Java implementation)

This method mimics the Java API wrapper’s approach where parameters are added to the query string and the file is uploaded separately.

Memory optimization: Uses Cow for strings and Arc for file data to minimize cloning during retry attempts. Automatically retries on transient failures.

§Arguments

endpoint - The API endpoint to call
query_params - Query parameters as key-value pairs
file_field_name - Name of the file field
filename - Name of the file
file_data - File data as bytes

§Returns

A Result containing the response or an error.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn post_with_query_params( &self, endpoint: &str, query_params: &[(&str, &str)], ) -> Result<Response, VeracodeError>

Make a POST request with query parameters (like Java implementation for XML API)

This method mimics the Java API wrapper’s approach for POST operations where parameters are added to the query string rather than form data.

§Arguments

endpoint - The API endpoint to call
query_params - Query parameters as key-value pairs

§Returns

A Result containing the response or an error.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn get_with_query_params( &self, endpoint: &str, query_params: &[(&str, &str)], ) -> Result<Response, VeracodeError>

Make a GET request with query parameters (like Java implementation for XML API)

This method mimics the Java API wrapper’s approach for GET operations where parameters are added to the query string.

§Arguments

endpoint - The API endpoint to call
query_params - Query parameters as key-value pairs

§Returns

A Result containing the response or an error.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn upload_large_file_chunked<F>( &self, endpoint: &str, query_params: &[(&str, &str)], file_path: &str, content_type: Option<&str>, progress_callback: Option<F>, ) -> Result<Response, VeracodeError>
where F: Fn(u64, u64, f64) + Send + Sync,

Upload a large file using chunked streaming (for uploadlargefile.do)

This method implements chunked upload functionality similar to the Java API wrapper. It uploads files in chunks and provides progress tracking capabilities.

§Arguments

endpoint - The API endpoint to call
query_params - Query parameters as key-value pairs
file_path - Path to the file to upload
content_type - Content type for the file (default: binary/octet-stream)
progress_callback - Optional callback for progress tracking

§Returns

A Result containing the response or an error.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn upload_file_binary( &self, endpoint: &str, query_params: &[(&str, &str)], file_data: Vec<u8>, content_type: &str, ) -> Result<Response, VeracodeError>

Upload a file with binary data (optimized for uploadlargefile.do)

This method uploads a file as raw binary data without multipart encoding, which is the expected format for the uploadlargefile.do endpoint.

Memory optimization: Uses Arc for file data and Cow for strings to minimize allocations during retry attempts. Automatically retries on transient failures.

§Arguments

endpoint - The API endpoint to call
query_params - Query parameters as key-value pairs
file_data - File data as bytes
content_type - Content type for the file

§Returns

A Result containing the response or an error.

§Errors

Returns an error if the API request fails, the resource is not found, or authentication/authorization fails.

Source

pub async fn upload_file_streaming( &self, endpoint: &str, query_params: &[(&str, &str)], file_path: &str, file_size: u64, content_type: &str, ) -> Result<Response, VeracodeError>

Upload a file with streaming (memory-efficient for large files)

This method streams the file directly from disk without loading it entirely into memory. This is the recommended approach for large files (>100MB) to avoid high memory usage.