Skip to main content
POST
/
v1
/
enrichment-field-extractions
Create Enrichment Field Extraction
curl --request POST \
  --url https://api.example.com/v1/enrichment-field-extractions \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_name": "<string>",
  "indicator_type": "<string>",
  "source_path": "<string>",
  "target_key": "<string>",
  "value_type": "string",
  "description": "<string>"
}
'
{
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider_name": "<string>",
    "indicator_type": "<string>",
    "source_path": "<string>",
    "target_key": "<string>",
    "value_type": "<string>",
    "is_system": true,
    "is_active": true,
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {}
}

Body

application/json

Request body for creating an enrichment field extraction.

​
provider_name
string
required

Provider this extraction belongs to

Required string length: 1 - 100
​
indicator_type
string
required

Indicator type: ip, domain, hash_md5, hash_sha1, hash_sha256, url, email, account

​
source_path
string
required

Dot-notation path into the raw enrichment response

Minimum string length: 1
​
target_key
string
required

Key in the extracted dict surfaced to agents

Minimum string length: 1
​
value_type
string
default:string

One of: string, int, float, bool, list, dict, any

​
description
string | null

Human-readable description

Response

Successful Response

​
data
EnrichmentFieldExtractionResponse · object
required

Response schema for enrichment field extraction endpoints.

​
meta
Meta · object