Reyhford
  • Documentation
  • API Reference
Information
TAXII
    TAXII DiscoverygetList CollectionsgetGet Objectsget
Health
    Health checkget
Indicators
    Search IndicatorspostGet IndicatorgetList Indicatorsget
Schemas
powered by Zuplo
Reyhford Threat Intelligence API
Reyhford Threat Intelligence API

Schemas


TaxiiDiscovery

title
​string
description
​string
versions
​string[]
max_content_length
​integer

CollectionList

​Collection[]

Collection

id
​string · uuid
title
​string
description
​string
can_read
​boolean
can_write
​boolean
media_types
​string[]

StixBundle

type
​string · enum
Enum values:
bundle
id
​string
spec_version
​string · enum
Enum values:
2.1
​StixIndicator[]
more
​boolean
next
​string

Pagination cursor

StixIndicator

STIX 2.1 indicator object — serialized by taxii-server from internal ThreatIndicator
type
​string · enum
Enum values:
indicator
spec_version
​string · enum
Enum values:
2.1
id
​string · uuid
created
​string · date-time
modified
​string · date-time
name
​string
pattern
​string
pattern_type
​string · enum
Enum values:
stix
valid_from
​string · date-time
confidence
​integer · min: 0 · max: 100
labels
​string[]

Error

code
​string
message
​string

commonV1Label

Free-form key/value label attached to an entity.
key
​string
value
​string

protobufAny

@type
​string
No data returned

rpcStatus

code
​integer · int32
message
​string
​protobufAny[]

v1AsnInfo

Autonomous system information for a network indicator.
number
​integer · int64
organization
​string

v1Enrichment

Enrichment data attached to an indicator by the enrichment pipeline.
​v1GeoLocation

Geolocation resolved for a network indicator.

​v1AsnInfo

Autonomous system information for a network indicator.

reverseDns
​string

Reverse DNS name, when resolvable.

malwareFamilies
​string[]

Related malware family names, if attributed.

attackTechniques
​string[]

MITRE ATT&CK technique IDs, e.g. "T1071.001".

aiSummary
​string

AI-generated analyst summary of the threat context.

riskScore
​number · double

Model-assessed risk score in [0.0, 1.0].

enrichedAt
​string · date-time
ipReputationJson
​string

Internal IP reputation snapshot (JSON), exported as STIX x-reyhford-reputation.

v1GeoLocation

Geolocation resolved for a network indicator.
countryCode
​string
city
​string
latitude
​number · double
longitude
​number · double

v1GetIndicatorResponse

​v1ThreatIndicator

A threat indicator (IOC) — the core entity of the platform.

v1IndicatorFilter

Declarative filter; all set fields are ANDed together.
types
​v1IndicatorType[]
Enum values:
INDICATOR_TYPE_UNSPECIFIED
INDICATOR_TYPE_IPV4
INDICATOR_TYPE_IPV6
INDICATOR_TYPE_DOMAIN
INDICATOR_TYPE_URL
INDICATOR_TYPE_FILE_HASH_MD5
INDICATOR_TYPE_FILE_HASH_SHA1
INDICATOR_TYPE_FILE_HASH_SHA256
categories
​v1ThreatCategory[]
Enum values:
THREAT_CATEGORY_UNSPECIFIED
THREAT_CATEGORY_MALWARE
THREAT_CATEGORY_PHISHING
THREAT_CATEGORY_COMMAND_AND_CONTROL
THREAT_CATEGORY_BOTNET
THREAT_CATEGORY_SCANNER
THREAT_CATEGORY_SPAM
THREAT_CATEGORY_BRUTE_FORCE
minSeverity
​v1Severity · enum

Severity of the threat the indicator represents.

Enum values:
SEVERITY_UNSPECIFIED
SEVERITY_INFO
SEVERITY_LOW
SEVERITY_MEDIUM
SEVERITY_HIGH
SEVERITY_CRITICAL
Default: SEVERITY_UNSPECIFIED
minConfidenceScore
​integer · int64

Minimum confidence score in [0, 100].

states
​v1IndicatorState[]
Enum values:
INDICATOR_STATE_UNSPECIFIED
INDICATOR_STATE_RAW
INDICATOR_STATE_SCORED
INDICATOR_STATE_ENRICHED
INDICATOR_STATE_VERIFIED
tags
​string[]
​v1TimeWindow

Half-open time interval [start, end).

sourceIds
​string[]
protocols
​v1Protocol[]

Restrict to indicators observed over these protocols; empty means all.

Enum values:
PROTOCOL_UNSPECIFIED
PROTOCOL_MODBUS
PROTOCOL_DNP3
PROTOCOL_BACNET
PROTOCOL_S7
PROTOCOL_OPC_UA
PROTOCOL_SSH
PROTOCOL_HTTP
sensorTypes
​v1SensorType[]

Restrict to indicators observed by these sensor kinds; empty means all.

Enum values:
SENSOR_TYPE_UNSPECIFIED
SENSOR_TYPE_ICS
SENSOR_TYPE_NETWORK
SENSOR_TYPE_ENDPOINT

v1IndicatorState

string · enum
Enum values:
INDICATOR_STATE_UNSPECIFIED
INDICATOR_STATE_RAW
INDICATOR_STATE_SCORED
INDICATOR_STATE_ENRICHED
INDICATOR_STATE_VERIFIED

Pipeline lifecycle state of an indicator: Raw → Scored → Enriched → Verified.

  • INDICATOR_STATE_RAW: Sensor event received, nothing computed yet.
  • INDICATOR_STATE_SCORED: pipeline-worker computed the confidence score.
  • INDICATOR_STATE_ENRICHED: ai-enricher attached MITRE ATT&CK context.
  • INDICATOR_STATE_VERIFIED: Confirmed by a human analyst.
Default: INDICATOR_STATE_UNSPECIFIED

v1IndicatorType

string · enum
Enum values:
INDICATOR_TYPE_UNSPECIFIED
INDICATOR_TYPE_IPV4
INDICATOR_TYPE_IPV6
INDICATOR_TYPE_DOMAIN
INDICATOR_TYPE_URL
INDICATOR_TYPE_FILE_HASH_MD5
INDICATOR_TYPE_FILE_HASH_SHA1
INDICATOR_TYPE_FILE_HASH_SHA256

Kind of observable the indicator describes.

Default: INDICATOR_TYPE_UNSPECIFIED

v1ListIndicatorsResponse

​v1ThreatIndicator[]
​v1PageInfo

Pagination metadata returned with list responses.

v1PageInfo

Pagination metadata returned with list responses.
nextPageToken
​string

Cursor to fetch the next page; empty when there are no more results.

totalCount
​string · uint64

Total number of items matching the query, if cheaply computable.

v1Pagination

Cursor-based pagination request parameters.
pageSize
​integer · int64

Maximum number of items to return. Server may cap this value.

pageToken
​string

Opaque cursor from a previous response; empty for the first page.

v1Protocol

string · enum
Enum values:
PROTOCOL_UNSPECIFIED
PROTOCOL_MODBUS
PROTOCOL_DNP3
PROTOCOL_BACNET
PROTOCOL_S7
PROTOCOL_OPC_UA
PROTOCOL_SSH
PROTOCOL_HTTP

Network protocol the observed activity used.

Default: PROTOCOL_UNSPECIFIED

v1SearchIndicatorsRequest

query
​string

Free-text query matched against value, tags and enrichment summary.

​v1IndicatorFilter

Declarative filter; all set fields are ANDed together.

​v1Pagination

Cursor-based pagination request parameters.

v1SearchIndicatorsResponse

​v1ThreatIndicator[]
​v1PageInfo

Pagination metadata returned with list responses.

v1SensorType

string · enum
Enum values:
SENSOR_TYPE_UNSPECIFIED
SENSOR_TYPE_ICS
SENSOR_TYPE_NETWORK
SENSOR_TYPE_ENDPOINT

Kind of sensor that produced an event.

  • SENSOR_TYPE_ICS: Industrial control system honeypot (Conpot etc.).
  • SENSOR_TYPE_NETWORK: Generic network honeypot.
  • SENSOR_TYPE_ENDPOINT: Endpoint / host-based sensor.
Default: SENSOR_TYPE_UNSPECIFIED

v1Severity

string · enum
Enum values:
SEVERITY_UNSPECIFIED
SEVERITY_INFO
SEVERITY_LOW
SEVERITY_MEDIUM
SEVERITY_HIGH
SEVERITY_CRITICAL

Severity of the threat the indicator represents.

Default: SEVERITY_UNSPECIFIED

v1Sighting

A single observation of the indicator in the wild.
sourceId
​string

Source that observed the indicator.

observedAt
​string · date-time
count
​string · uint64

Number of occurrences aggregated into this sighting.

v1ThreatCategory

string · enum
Enum values:
THREAT_CATEGORY_UNSPECIFIED
THREAT_CATEGORY_MALWARE
THREAT_CATEGORY_PHISHING
THREAT_CATEGORY_COMMAND_AND_CONTROL
THREAT_CATEGORY_BOTNET
THREAT_CATEGORY_SCANNER
THREAT_CATEGORY_SPAM
THREAT_CATEGORY_BRUTE_FORCE

Threat classification of the indicator.

Default: THREAT_CATEGORY_UNSPECIFIED

v1ThreatIndicator

A threat indicator (IOC) — the core entity of the platform.
id
​string

UUID assigned by the platform.

type
​v1IndicatorType · enum

Kind of observable the indicator describes.

Enum values:
INDICATOR_TYPE_UNSPECIFIED
INDICATOR_TYPE_IPV4
INDICATOR_TYPE_IPV6
INDICATOR_TYPE_DOMAIN
INDICATOR_TYPE_URL
INDICATOR_TYPE_FILE_HASH_MD5
INDICATOR_TYPE_FILE_HASH_SHA1
INDICATOR_TYPE_FILE_HASH_SHA256
Default: INDICATOR_TYPE_UNSPECIFIED
value
​string

Normalized observable value, e.g. "203.0.113.7" or a lowercase SHA-256.

categories
​v1ThreatCategory[]
Enum values:
THREAT_CATEGORY_UNSPECIFIED
THREAT_CATEGORY_MALWARE
THREAT_CATEGORY_PHISHING
THREAT_CATEGORY_COMMAND_AND_CONTROL
THREAT_CATEGORY_BOTNET
THREAT_CATEGORY_SCANNER
THREAT_CATEGORY_SPAM
THREAT_CATEGORY_BRUTE_FORCE
severity
​v1Severity · enum

Severity of the threat the indicator represents.

Enum values:
SEVERITY_UNSPECIFIED
SEVERITY_INFO
SEVERITY_LOW
SEVERITY_MEDIUM
SEVERITY_HIGH
SEVERITY_CRITICAL
Default: SEVERITY_UNSPECIFIED
confidenceScore
​integer · int64

Confidence in [0, 100]; computed by domain rules, adjusted by enrichment.

tlp
​v1TlpMarking · enum

Traffic Light Protocol 2.0 sharing marking.

Enum values:
TLP_MARKING_UNSPECIFIED
TLP_MARKING_CLEAR
TLP_MARKING_GREEN
TLP_MARKING_AMBER
TLP_MARKING_AMBER_STRICT
TLP_MARKING_RED
Default: TLP_MARKING_UNSPECIFIED
state
​v1IndicatorState · enum

Pipeline lifecycle state of an indicator: Raw → Scored → Enriched → Verified.

  • INDICATOR_STATE_RAW: Sensor event received, nothing computed yet.
  • INDICATOR_STATE_SCORED: pipeline-worker computed the confidence score.
  • INDICATOR_STATE_ENRICHED: ai-enricher attached MITRE ATT&CK context.
  • INDICATOR_STATE_VERIFIED: Confirmed by a human analyst.
Enum values:
INDICATOR_STATE_UNSPECIFIED
INDICATOR_STATE_RAW
INDICATOR_STATE_SCORED
INDICATOR_STATE_ENRICHED
INDICATOR_STATE_VERIFIED
Default: INDICATOR_STATE_UNSPECIFIED
firstSeen
​string · date-time
lastSeen
​string · date-time
validUntil
​string · date-time

After this instant the indicator is considered stale.

​v1ThreatSource[]
​v1Sighting[]
​v1Enrichment

Enrichment data attached to an indicator by the enrichment pipeline.

tags
​string[]
​commonV1Label[]
createdAt
​string · date-time
updatedAt
​string · date-time
protocol
​v1Protocol · enum

Network protocol the observed activity used.

Enum values:
PROTOCOL_UNSPECIFIED
PROTOCOL_MODBUS
PROTOCOL_DNP3
PROTOCOL_BACNET
PROTOCOL_S7
PROTOCOL_OPC_UA
PROTOCOL_SSH
PROTOCOL_HTTP
Default: PROTOCOL_UNSPECIFIED
sensorType
​v1SensorType · enum

Kind of sensor that produced an event.

  • SENSOR_TYPE_ICS: Industrial control system honeypot (Conpot etc.).
  • SENSOR_TYPE_NETWORK: Generic network honeypot.
  • SENSOR_TYPE_ENDPOINT: Endpoint / host-based sensor.
Enum values:
SENSOR_TYPE_UNSPECIFIED
SENSOR_TYPE_ICS
SENSOR_TYPE_NETWORK
SENSOR_TYPE_ENDPOINT
Default: SENSOR_TYPE_UNSPECIFIED

v1ThreatSource

Origin feed or sensor that reported an indicator.
id
​string

Stable source identifier, e.g. "edge-honeypot-eu-1" or "abusech-urlhaus".

name
​string

Human-readable source name.

reliability
​number · double

Reliability score of the source in [0.0, 1.0].

reportedAt
​string · date-time

When this source first reported the indicator.

v1TimeWindow

Half-open time interval [start, end).
start
​string · date-time
end
​string · date-time

v1TlpMarking

string · enum
Enum values:
TLP_MARKING_UNSPECIFIED
TLP_MARKING_CLEAR
TLP_MARKING_GREEN
TLP_MARKING_AMBER
TLP_MARKING_AMBER_STRICT
TLP_MARKING_RED

Traffic Light Protocol 2.0 sharing marking.

Default: TLP_MARKING_UNSPECIFIED
On this page
  • TaxiiDiscovery
  • CollectionList
  • Collection
  • StixBundle
  • StixIndicator
  • Error
  • commonV1Label
  • protobufAny
  • rpcStatus
  • v1AsnInfo
  • v1Enrichment
  • v1GeoLocation
  • v1GetIndicatorResponse
  • v1IndicatorFilter
  • v1IndicatorState
  • v1IndicatorType
  • v1ListIndicatorsResponse
  • v1PageInfo
  • v1Pagination
  • v1Protocol
  • v1SearchIndicatorsRequest
  • v1SearchIndicatorsResponse
  • v1SensorType
  • v1Severity
  • v1Sighting
  • v1ThreatCategory
  • v1ThreatIndicator
  • v1ThreatSource
  • v1TimeWindow
  • v1TlpMarking