For AI agents: visit https://threatconnect.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Home
Guides
API Reference
Log In
API Reference
Log In
Home
Guides
API Reference
Update Document
ThreatConnect v3 API Overview
Introduction
Getting Started
Postman Configuration
Features
Create Activity Logs
Create and Manage Associations
Delete Case Objects in Bulk
Enable Pagination
Filter Results With TQL
HTTP Status Codes
Include Additional Fields in API Responses
Retrieve a List of Available Fields for an Endpoint
Retrieve OpenAPI Documentation
Return a Count of Items
Sort Results
Specify an Owner
Update an Object's Metadata
Available Endpoints
ThreatConnect API
Artifacts
Artifacts Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create Artifact
post
Retrieve Artifacts
get
Retrieve Artifact by ID
get
Update Artifact
put
Delete Artifacts
del
Delete Artifact by ID
del
Artifact Types
Artifact Types Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Retrieve ArtifactTypes
get
Retrieve ArtifactType by ID
get
Attribute Types
Attribute Types Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Retrieve AttributeTypes
get
Retrieve AttributeType by ID
get
Case Attributes
Case Attributes Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create CaseAttribute
post
Retrieve CaseAttributes
get
Retrieve CaseAttribute by ID
get
Update CaseAttribute by ID
put
Delete CaseAttribute by ID
del
Case Notes
Notes Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create Note
post
Retrieve Notes
get
Retrieve Note by ID
get
Update Note by ID
put
Delete Notes
del
Delete Note by ID
del
Cases
Cases Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create Case
post
Retrieve Cases
get
Retrieve Case by ID
get
Update Case
put
Delete Cases
del
Delete Case by ID
del
Exclusion List
Exclusion Lists Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create ExclusionList
post
Retrieve ExclusionLists
get
Retrieve ExclusionList by ID
get
Update ExclusionList by ID
put
Delete ExclusionList by ID
del
Group Attributes
Group Attributes Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create GroupAttribute
post
Retrieve GroupAttributes
get
Retrieve GroupAttribute by ID
get
Update GroupAttribute by ID
put
Delete GroupAttribute by ID
del
Groups
Groups Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create Group
post
Create Document
post
Retrieve Groups
get
Retrieve Group by ID
get
Retrieve Document
get
Retrieve PDF
get
Retrieve Event Type Categories
get
Update Group by ID
put
Update Document
put
Delete Group by ID
del
Indicator Attributes
Indicator Attributes Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create IndicatorAttribute
post
Retrieve IndicatorAttributes
get
Retrieve IndicatorAttribute by ID
get
Update IndicatorAttribute by ID
put
Delete IndicatorAttribute by ID
del
Indicator Enrichment
Indicator Enrichment Overview
Enrich Indicators
post
Enrich Indicator
post
Indicators
Indicators Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create Indicator
post
Retrieve Indicators
get
Retrieve Indicator by ID
get
Retrieve Deleted Indicators
get
Update Indicator by ID
put
Delete Indicator by ID
del
IntelRequirements
Intelligence Requirements Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create Intel Requirement
post
Retrieve Intel Requirements
get
Retrieve Intel Requirement by ID
get
Update Intel Requirement by ID
put
Delete Intel Requirement by ID
del
IntelRequirementsCategories
Intelligence Requirement Categories Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Retrieve Intel Requirements Categories
get
Retrieve Intel Requirement Category by ID
get
IntelRequirementsResults
Intelligence Requirement Results Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Retrieve Intel Requirements Results
get
Retrieve Intel Requirement Result by ID
get
Update Intel Requirement Result by ID
put
Delete Intel Requirement Result by ID
del
IntelRequirementsSubtypes
Intelligence Requirement Subtypes Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Retrieve Intel Requirements Subtypes
get
Retrieve Intel Requirement Subtype by ID
get
Job Executions
Job Executions Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Jobs
Jobs Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Notifications
Notifications Overview
Notification Schemas
Notification Snippets
Retrieve fields
optns
Retrieve entity info
optns
Retrieve tql
optns
Owner Roles
Owner Roles Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Retrieve OwnerRoles
get
Retrieve OwnerRole by ID
get
Owners
Owners Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Retrieve Owners
get
Retrieve Owner by ID
get
Playbook Executions
Playbook Executions Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Playbooks
Playbooks Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Posts
Posts Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create Post
post
Create Post Reply
post
Retrieve Posts
get
Retrieve Post by ID
get
Delete Post by ID
del
Delete Post Reply by ID
del
Security Labels
Security Labels Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Retrieve SecurityLabels
get
Retrieve SecurityLabel by ID
get
System Roles
System Roles Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Retrieve SystemRoles
get
Retrieve SystemRole by ID
get
Tags
Tags Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Create Tag
post
Retrieve Tags
get
Retrieve Tag by ID
get
Update Tag by ID
put
Delete Tag by ID
del
TC Exchange Administration
User Groups
User Groups Overview
Retrieve entity info
optns
Retrieve fields
optns
Retrieve tql
optns
Retrieve UserGroups
get
Retrieve UserGroup by ID
get
Users
