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": {}
}
'
import requests

url = "https://api.example.com/v1/enrichment-providers/{provider_uuid}"

payload = {
    "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": {}
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {}
  })
};

fetch('https://api.example.com/v1/enrichment-providers/{provider_uuid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/enrichment-providers/{provider_uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/enrichment-providers/{provider_uuid}"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"is_active\": true,\n  \"supported_indicator_types\": [\n    \"<string>\"\n  ],\n  \"http_config\": {},\n  \"auth_type\": \"<string>\",\n  \"auth_config\": {},\n  \"default_cache_ttl_seconds\": 43200,\n  \"cache_ttl_by_type\": {},\n  \"malice_rules\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.example.com/v1/enrichment-providers/{provider_uuid}")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"is_active\": true,\n  \"supported_indicator_types\": [\n    \"<string>\"\n  ],\n  \"http_config\": {},\n  \"auth_type\": \"<string>\",\n  \"auth_config\": {},\n  \"default_cache_ttl_seconds\": 43200,\n  \"cache_ttl_by_type\": {},\n  \"malice_rules\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/enrichment-providers/{provider_uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"is_active\": true,\n  \"supported_indicator_types\": [\n    \"<string>\"\n  ],\n  \"http_config\": {},\n  \"auth_type\": \"<string>\",\n  \"auth_config\": {},\n  \"default_cache_ttl_seconds\": 43200,\n  \"cache_ttl_by_type\": {},\n  \"malice_rules\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "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": {}
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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 | null
auth_type
string | null
auth_config
Auth Config · object | null
default_cache_ttl_seconds
integer | null
Required range: 0 <= x <= 86400
cache_ttl_by_type
Cache Ttl By Type · object | null
malice_rules
Malice Rules · object | null

Response

Successful Response

data
EnrichmentProviderResponse · object
required

Response schema for enrichment provider endpoints.

meta
Meta · object