Skip to main content
PATCH
/
v1
/
enrichment-providers
/
{provider_uuid}
Patch Enrichment Provider
curl --request PATCH \
  --url https://api.example.com/v1/enrichment-providers/{provider_uuid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "description": "<string>",
  "is_active": true,
  "supported_indicator_types": [
    "<string>"
  ],
  "http_config": {},
  "auth_type": "<string>",
  "auth_config": {},
  "default_cache_ttl_seconds": 43200,
  "cache_ttl_by_type": {},
  "malice_rules": {}
}
'
{
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider_name": "<string>",
    "display_name": "<string>",
    "is_builtin": true,
    "is_active": true,
    "supported_indicator_types": [
      "<string>"
    ],
    "http_config": {},
    "auth_type": "<string>",
    "default_cache_ttl_seconds": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "has_credentials": false,
    "is_configured": false,
    "env_var_mapping": {},
    "cache_ttl_by_type": {},
    "malice_rules": {}
  },
  "meta": {}
}

Path Parameters

provider_uuid
string<uuid>
required

Body

application/json

Request body for PATCH /v1/enrichment-providers/{uuid}.

display_name
string | null
Required string length: 1 - 200
description
string | null
is_active
boolean | null
supported_indicator_types
string[] | null
http_config
Http Config · object
auth_type
string | null
auth_config
Auth Config · object
default_cache_ttl_seconds
integer | null
Required range: 0 <= x <= 86400
cache_ttl_by_type
Cache Ttl By Type · object
malice_rules
Malice Rules · object

Response

Successful Response

data
EnrichmentProviderResponse · object
required

Response schema for enrichment provider endpoints.

meta
Meta · object