Package Documentation
Storm Package: synapse-feedly
The following Commands are available from this package. This documentation is generated for version 0.1.0 of the package.
Storm Commands
This package implements the following Storm Commands.
feedly.config.add
Add a Synapse-Feedly configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Add a global configuration
feedly.config.add global_config apikey1234
// Add a configuration for the current user
feedly.config.add --scope self my_config apikey5678
Usage: feedly.config.add [options] <name> <apikey>
Options:
--help : Display the command usage.
--ssl-noverify : Do not perform SSL/TLS verification.
--proxy <proxy> : Configure the proxy usage. (default: True)
--tag-prefix <tag_prefix> : The tag prefix to use when recording data from Feedly. (default: rep.feedly)
--scope <scope> : Set the scope on the configuration. (default: global, choices: global, self, unscoped)
Arguments:
<name> : A unique name for the configuration.
<apikey> : The API key string.
feedly.config.del
Delete a Synapse-Feedly configuration.
Examples:
// Delete the "fooconfig" configuration
feedly.config.del fooconfig
Usage: feedly.config.del [options] <name>
Options:
--help : Display the command usage.
Arguments:
<name> : The name of the configuration.
feedly.config.list
Display the list of Synapse-Feedly configurations you have access to.
Usage: feedly.config.list [options]
Options:
--help : Display the command usage.
feedly.config.migrate
Migrate options for all Synapse-Feedly configurations.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Migrate the tag prefix for all configurations
feedly.config.migrate --tag-prefix my.tagpref
Usage: feedly.config.migrate [options]
Options:
--help : Display the command usage.
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--tag-prefix <tag_prefix> : The tag prefix to use when recording data from Feedly. (default: None)
feedly.config.show
Show the details of a configuration.
Examples:
// Show the in-use configuration for the current user
feedly.config.show
// Show a configuration by name
feedly.config.show myconfig
Usage: feedly.config.show [options] <name>
Options:
--help : Display the command usage.
Arguments:
[name] : The name of the configuration.
feedly.config.update
Update the configuration of a defined Synapse-Feedly configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Set the permission level for user "myuser" to "admin" on the "fooconfig"
// configuration
feedly.config.update fooconfig --perm user myuser admin
// Set the permission level for the "all" role to "deny" on the
// "fooconfig" configuration
feedly.config.update fooconfig --perm role all deny
// Do not verify the SSL certificate when connecting to "fooconfig"
feedly.config.update fooconfig --ssl-verify (false)
// Change the name of the "fooconfig" configuration to "barconfig"
feedly.config.update fooconfig --name barconfig
Usage: feedly.config.update [options] <config>
Options:
--help : Display the command usage.
--apikey <apikey> : The API key string. (default: None)
--perm <perm> : Set the permission level for a user or role in this configuration.
Arguments to this option are ``scope``, ``name``, ``level``:
<scope>: The scope for the permission, either "user" or "role".
<name>: The user/role name depending on scope.
<level>: The $lib.auth.easyperm.level, or None to remove the permission.
(default: None)
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--tag-prefix <tag_prefix> : The tag prefix to use when recording data from Feedly. (default: None)
--name <name> : Rename the configuration. (default: None)
Arguments:
<config> : The name of the configuration to modify.
feedly.streams.get
Retrieve the contents of a Feedly stream, along with the associated thumbnails, IOCs, and Mitre ATT&CK data.
Examples:
// Retrieve the first 10 articles in a feed, and the articles' associated Mitre ATT&CK techniques
// and IOCs.
meta:feed#my.feeds.daily | feedly.streams.get --yield --size 10
// Retrieve only a feed's articles and associated vulnerability info.
meta:feed#my.feeds.daily | feedly.streams.get --yield --no-thumbnails --no-iocs
// Retrieve only the articles that have been posted since the last run of this command with --since-last.
meta:feed#my.feeds.daily | feedly.streams.get --yield --no-thumbnails --no-iocs --since-last
Usage: feedly.streams.get [options]
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
--yield : Yield the newly created nodes.
--config <config> : Override the default config with the provided name.
--size <size> : Limit the number of results ingested to the given size (per-node).
--no-thumbnails : Do not fetch or ingest Feedly article image thumbnails.
--no-iocs : Do not fetch or ingest the IOCs for the ingested Feedly articles.
--since-last : Retrieve results since the last run of the command with --since-last specified.
feedly.streams.list
Retrieve the list of Feedly Team streams as meta:feed nodes.
Example:
// List the Feedly streams associated with the account.
feedly.streams.list
Usage: feedly.streams.list [options]
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
--config <config> : Override the default config with the provided name.
--size <size> : Limit the number of results ingested to the given size (per-node).
Storm Modules
This package does not export any Storm APIs.