Document the URL_DOWNLOAD threat intelligence source type - #12937
Document the URL_DOWNLOAD threat intelligence source type#12937kolchfa-aws wants to merge 2 commits into
Conversation
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). |
|
@AWSHurneyt could you review this PR? |
|
Tagging @kanwaljeetd to assign reviewer from the security analytics plugin team. |
| | Field | Type | Description | | ||
| | :--- | :--- | :---- | | ||
| | `type` | String | The type of threat intelligence source, such as `S3_CUSTOM` or `IOC_UPLOAD`. | | ||
| | `type` | String | The type of threat intelligence source. Valid values are `S3_CUSTOM`, `IOC_UPLOAD`, and `URL_DOWNLOAD`. You can only create `S3_CUSTOM` and `IOC_UPLOAD` sources using this API. | |
There was a problem hiding this comment.
let's not mention that URL_DOWNLOAD is a valid value.
There was a problem hiding this comment.
above mentioned sentence calling out url_download is internal only suffices.
There was a problem hiding this comment.
@eirsep Thanks - removed the url_download from valid values.
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Description
Addresses user feedback submitted through the documentation feedback widget on July 29, 2026:
The Source API page documented only the
S3_CUSTOMandIOC_UPLOADsource types. The stringsURL_DOWNLOADandurl_downloadappeared nowhere in the threat intelligence documentation.Importantly,
URL_DOWNLOADis not a third source type users can create — it is reserved for built-in feeds, and a create request returns a 400. This PR documents the type and its restrictions rather than adding a create example that would fail for every reader.Changes:
URL_DOWNLOADto thetypeparameter description and documented thesource_config.source.url_download.*parameters.S3_CUSTOMtype source." Refresh actually excludes onlyIOC_UPLOAD.Testing
Parameter names came from
UrlDownloadSource.javafield constants and were confirmed against live API responses on a local 3.8.0 cluster. Verified empirically:URL_DOWNLOADsource returnsURL_DOWNLOAD source type cannot be created via the REST API. It is reserved for internal use only.alienvault_reputation_ip_database.enabled_for_scan; other field changes are rejected, andscheduleis required.Cannot delete built-in tif source config.URL_DOWNLOADfeed and fails onIOC_UPLOAD, confirming the Refresh correction.csvis the only supportedfeed_format.Two spellings look like typos but are genuine upstream field names, preserved verbatim so copy-paste works:
has_csv_header_fieldandcsv_ioc_value_colum_num.Note for reviewers
The page is written against current behavior without version qualifiers. The REST-API restriction is present in
main,3.7, and3.8but absent from2.19,3.0,3.5, and3.6, and the backport PRs (opensearch-project/security-analytics#1671–#1680) are still open. If version callouts are wanted, that depends on whether those backports land.The version that introduced the type is not claimed on the page because it could not be confirmed. Separately,
CUSTOM_SCHEMA_IOC_UPLOADalso exists inSource.javaand remains undocumented — out of scope here.Issues Resolved
N/A — reported through the site feedback widget.
Check List
git commit -s)By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.