Test firehose's ability to write to AWS S3 or Azure Blob Storage
The /firehose resource is used to validate cloud storage credentials and test
write access to a specified bucket/container.
AWS S3 Validation:
- Creates a test file with unique name
leadconduit_verification_[flow_id_]YYYYMMDDHHMMSSMS.txt - File location:
<prefix>/filename(if prefix provided) orfilename(root of bucket) - Returns S3 putObject response with ETag on success
- Can validate credentials without creating file when
verification_file=false
Azure Blob Storage Validation:
- Validates credentials by checking container existence and access permissions
- Optionally creates verification file based on
verification_fileparameter - Returns container validation information on success
Required Parameters:
- For AWS:
access_key_id,secret_access_key,bucket - For Azure:
connection_string,bucket(container name) - The
serviceparameter determines which validation method is used
Optional Parameters:
flow_id: Include flow ID in verification filename for better trackingverification_file: Control whether verification file is created (default: true)
Authorizations
LeadConduit uses HTTP Basic Authentication
with the username API and your API key as the password.
For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f'
Query Parameters
Cloud service provider. Defaults to 'aws' if not specified.
aws, azure AWS Access Key ID for S3 authentication. Required when service is 'aws' or not specified.
AWS Secret Access Key for S3 authentication. Required when service is 'aws' or not specified.
Azure Storage account connection string for Blob Storage authentication. Required when service is 'azure'.
Storage container name. For AWS: S3 bucket name. For Azure: Blob Storage container name.
3 - 63^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$Optional path prefix for stored files.
- For AWS: Files will be stored as
<prefix>/leadconduit_verification_[flow_id_]YYYYMMDDHHMMSSMS.txt - For Azure: Currently not used in validation but stored for future use
Optional flow identifier to include in verification filename.
When provided, filename becomes: leadconduit_verification_{flow_id}_{timestamp}.txt
When omitted, filename becomes: leadconduit_verification_{timestamp}.txt
Whether to create the verification file during validation.
true(default): Creates verification file and validates credentialsfalse: Only validates credentials/permissions without creating file For AWS: uses headBucket operation instead of putObject when false For Azure: skips file upload step when false
true, false