S3 Config Yaml Structure

[Kumar-IND]

Hi Team,
i am raising github issue what i need to add
cat s3-config.json
{
"sources": [
{
"source": "s3",
"bucket_name": "data-datalake-raw-east-stage",
"prefix": "db-reporting/test/year=2024/month=6/day=13/",
"region": "us-east-1"
}
]
}
:~# trufflehog --version
trufflehog 3.90.3
~# cat s3-config.json
{
"sources": [
{
"source": "s3",
"bucket_name": "xyz-test-raw-east-stage",
"prefix": "db-reporting/data/year=2024/month=6/day=13/",
"region": "us-east-1"
}
]
}

I Granted required s3 access but getting below syntax error

Getting below error
~# trufflehog multi-scan --config s3-config.json --only-verified --json
{"level":"error","ts":"2025-08-07T13:47:20Z","logger":"trufflehog","msg":"error parsing the provided configuration file","error":"proto: (line 1:14): unknown field "bucket_name""}
help me for correct syntax

[shahzadhaider1]

Hi @Kumar-IND,

Thank you for taking the time to open this issue, we really appreciate your contribution to the project!
We’ll take a look and get back to you as soon as we can. If we need any clarification, we’ll follow up here.

[kashifkhan0771]

Hi @Kumar-IND,
Here's an example of how the S3 source YAML should look when using static credentials:

sources:
  - connection:
      '@type': type.googleapis.com/sources.S3
      accessKey:
        key: AKIAKEYID
        secret: XXXXXXXXXXXXXXXXXXXXXXXXXX
      buckets:
        - bucket-one
        - bucket-two
    name: S3
    scanPeriod: 12h
    type: SOURCE_TYPE_S3
    verify: true

You can find more details in the documentation here:
🔗 https://docs.trufflesecurity.com/aws-s3

Note: You can only use this with multi-scan command.

CC: @mcastorina

[Kumar-IND]

Hi @kashifkhan0771 ,
when i tried above config getting below error
:~# cat s3-config.yaml
sources:

• connection:
  '@type': type.googleapis.com/sources.S3
  accessKey:
  key: xxxxx
  secret: /1290
  buckets:
  - data-datalake-raw-east-stage
  prefixes:
  - db-reporting/tesr/year=2024/month=6/day=13/
  name: S3
  scanPeriod: 12h
  type: SOURCE_TYPE_S3
  verify: true

:~# trufflehog multi-scan --config s3-config.yaml --only-verified --json
{"level":"error","ts":"2025-08-08T07:23:19Z","logger":"trufflehog","msg":"error parsing the provided configuration file","error":"proto: (line 1:210): unknown field "prefixes""}
also when i used region:us-east-1 also getting error could ypu share me proper syntax doc or reference example for s3

[kashifkhan0771]

Hey, yes I’ve shared the document in the comment above.

Just to clarify, there are no fields named prefixes or region in the S3 source configuration. That’s why including them
results in an error. I recommend referring to the official documentation for the correct way to configure the S3 source.

Let me know if you have any further questions!

[Kumar-IND]

Hi @kashifkhan0771 ,
I couldn’t find any documentation related to scanning a specific prefix (path), nor did I find any option to specify the region or perform a PII address scan and retrieve the results. Could you please confirm if there is any documentation available for this?

[kashifkhan0771]

The prefix and region is not supported in configuration as of now.