ThreatConnect App Framework (TcEx)

Release 2.0.18.

Table of Contents

• Overview
• Features
• Building Apps: Quick Start
  • Initializing an App
  • Building the “lib” Directory
  • Packaging an App
• Building Apps: Templates (tcinit)
  • Summary
  • Usage
  • Job App Templates
  • Playbook App Templates
  • External App Templates
• Building Apps: Dependencies (tclib)
  • Summary
  • Usage
  • Using a Configuration File
• Building Apps: Packaging (tcpackage)
  • Summary
  • Usage
  • Configuration Options
• App-Deployment Configuration
  • App-Deployment Configuration File
• App-Directory Structure
  • .gitignore (optional)
  • .pre-commit-config.yaml (optional)
  • README.md (required)
  • __main__.py (required)
  • app.py (required)
  • args.py (required)
  • install.json (required)
  • log (temporary)
  • log/app.log (temporary)
  • log/message.tc (temporary)
  • log/run.log (temporary)
  • playbook_app.py (required)
  • pyproject.toml (optional)
  • requirements.txt (required)
  • run.py (required)
  • setup.cfg (optional)
  • tcex.json (required)
• Module: Batch
  • External ID (xid)
  • Groups
  • Indicators
  • Associations
  • Submit
• Module: Cache
  • DataStore Instance
  • Add Record
  • Delete Record
  • Get Record
  • Update Record
• Module: Case Management
  • Create
  • Delete
  • Get
• Module: Datastore
  • DataStore Instance
  • Add Record
  • Delete Record
  • Get Record
  • Update Record
• Module: Decorators
  • Fail on Output
  • Iterate On Arg
  • On Exception
  • On Success
  • Output
  • Read Arg
• Module: Metrics
  • Metrics Instance
  • Add Metrics
  • Add Keyed Metrics
• Module: Notifications
  • Notification Instance
  • Recipients
  • Organization
  • Send
• Module: Playbooks
  • Understanding Playbooks
  • Playbook Flow
  • Input Variables
  • Output Variables
  • Variable Types
• Module: Services
• Module: Threat Intelligence
  • Single Results
  • Multiple Results
  • Groups
  • Indicators
  • Owners
• Module: Utils
  • Format DateTime
  • Date to Datetime
  • Human Time to Datetime
  • UNIX Time to Datetime
• Authorization (Token/HMAC)
  • Token Refresh
  • HMAC Authorization
• Exit
  • Setting the Exit Code
  • Immediate Exit on Failure
  • Job App Exit Codes
  • Playbook App Exit Codes
• Examples
  • Threat Intelligence
  • Snippets
• Logging
• Message TC
• Parser/Args
  • API Arguments
  • Batch Arguments
  • Playbook Arguments
  • Standard Arguments
  • Custom Arguments
• Proxies
  • Example Request using Proxy
• Results TC
• Release Notes
  • 2.0.18
  • 2.0.17
  • 2.0.16
  • 2.0.15
  • 2.0.14
  • 2.0.13
  • 2.0.12
  • 2.0.11
  • 2.0.10
  • 2.0.9
  • 2.0.8
  • 2.0.7
  • 2.0.6
  • 2.0.5
  • 2.0.4
  • 2.0.3
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.1.x
  • 1.0.x
  • 0.9.x
  • 0.8.x
  • 0.7.x
  • 0.6.x
  • 0.5.x
  • 0.4.x
  • 0.3.x
  • 0.2.x
  • 0.1.x
  • 0.0.x
• TcEx Package
  • Modules
  • Module contents

Indices and tables

• Index

• Module Index