Update a prehandler

curl --request PUT \
  --url https://api.extole.io/v6/prehandlers/{prehandlerId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actions": [
    {
      "expression": {},
      "type": "EXPRESSION"
    }
  ],
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "conditions": [
    {
      "considered_block_list_types": [
        "CIDR"
      ],
      "type": "BLOCK_MATCH"
    }
  ],
  "description": "description",
  "enabled": true,
  "name": "name",
  "order": 1,
  "tags": [
    "tag"
  ]
}
'

import requests

url = "https://api.extole.io/v6/prehandlers/{prehandlerId}"

payload = {
    "actions": [
        {
            "expression": {},
            "type": "EXPRESSION"
        }
    ],
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "conditions": [
        {
            "considered_block_list_types": ["CIDR"],
            "type": "BLOCK_MATCH"
        }
    ],
    "description": "description",
    "enabled": True,
    "name": "name",
    "order": 1,
    "tags": ["tag"]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actions: [{expression: {}, type: 'EXPRESSION'}],
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    conditions: [{considered_block_list_types: ['CIDR'], type: 'BLOCK_MATCH'}],
    description: 'description',
    enabled: true,
    name: 'name',
    order: 1,
    tags: ['tag']
  })
};

fetch('https://api.extole.io/v6/prehandlers/{prehandlerId}', 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.extole.io/v6/prehandlers/{prehandlerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'actions' => [
        [
                'expression' => [
                                
                ],
                'type' => 'EXPRESSION'
        ]
    ],
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'conditions' => [
        [
                'considered_block_list_types' => [
                                'CIDR'
                ],
                'type' => 'BLOCK_MATCH'
        ]
    ],
    'description' => 'description',
    'enabled' => true,
    'name' => 'name',
    'order' => 1,
    'tags' => [
        'tag'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.extole.io/v6/prehandlers/{prehandlerId}"

	payload := strings.NewReader("{\n  \"actions\": [\n    {\n      \"expression\": {},\n      \"type\": \"EXPRESSION\"\n    }\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"conditions\": [\n    {\n      \"considered_block_list_types\": [\n        \"CIDR\"\n      ],\n      \"type\": \"BLOCK_MATCH\"\n    }\n  ],\n  \"description\": \"description\",\n  \"enabled\": true,\n  \"name\": \"name\",\n  \"order\": 1,\n  \"tags\": [\n    \"tag\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.put("https://api.extole.io/v6/prehandlers/{prehandlerId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actions\": [\n    {\n      \"expression\": {},\n      \"type\": \"EXPRESSION\"\n    }\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"conditions\": [\n    {\n      \"considered_block_list_types\": [\n        \"CIDR\"\n      ],\n      \"type\": \"BLOCK_MATCH\"\n    }\n  ],\n  \"description\": \"description\",\n  \"enabled\": true,\n  \"name\": \"name\",\n  \"order\": 1,\n  \"tags\": [\n    \"tag\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/prehandlers/{prehandlerId}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"actions\": [\n    {\n      \"expression\": {},\n      \"type\": \"EXPRESSION\"\n    }\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"conditions\": [\n    {\n      \"considered_block_list_types\": [\n        \"CIDR\"\n      ],\n      \"type\": \"BLOCK_MATCH\"\n    }\n  ],\n  \"description\": \"description\",\n  \"enabled\": true,\n  \"name\": \"name\",\n  \"order\": 1,\n  \"tags\": [\n    \"tag\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "actions": [
    {
      "id": "<string>",
      "type": "EXPRESSION",
      "expression": {}
    }
  ],
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "conditions": [
    {
      "id": "<string>",
      "type": "BLOCK_MATCH",
      "considered_block_list_types": []
    }
  ],
  "created_date": "2025-10-24T02:00:00-07:00",
  "description": "<string>",
  "enabled": true,
  "id": "<string>",
  "name": "<string>",
  "order": 123,
  "tags": [
    "<string>"
  ],
  "updated_date": "2025-10-24T02:00:00-07:00"
}

PUT

prehandlers

{prehandlerId}

Update a prehandler

curl --request PUT \
  --url https://api.extole.io/v6/prehandlers/{prehandlerId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actions": [
    {
      "expression": {},
      "type": "EXPRESSION"
    }
  ],
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "conditions": [
    {
      "considered_block_list_types": [
        "CIDR"
      ],
      "type": "BLOCK_MATCH"
    }
  ],
  "description": "description",
  "enabled": true,
  "name": "name",
  "order": 1,
  "tags": [
    "tag"
  ]
}
'

import requests

url = "https://api.extole.io/v6/prehandlers/{prehandlerId}"

payload = {
    "actions": [
        {
            "expression": {},
            "type": "EXPRESSION"
        }
    ],
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "conditions": [
        {
            "considered_block_list_types": ["CIDR"],
            "type": "BLOCK_MATCH"
        }
    ],
    "description": "description",
    "enabled": True,
    "name": "name",
    "order": 1,
    "tags": ["tag"]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actions: [{expression: {}, type: 'EXPRESSION'}],
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    conditions: [{considered_block_list_types: ['CIDR'], type: 'BLOCK_MATCH'}],
    description: 'description',
    enabled: true,
    name: 'name',
    order: 1,
    tags: ['tag']
  })
};

fetch('https://api.extole.io/v6/prehandlers/{prehandlerId}', 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.extole.io/v6/prehandlers/{prehandlerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'actions' => [
        [
                'expression' => [
                                
                ],
                'type' => 'EXPRESSION'
        ]
    ],
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'conditions' => [
        [
                'considered_block_list_types' => [
                                'CIDR'
                ],
                'type' => 'BLOCK_MATCH'
        ]
    ],
    'description' => 'description',
    'enabled' => true,
    'name' => 'name',
    'order' => 1,
    'tags' => [
        'tag'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.extole.io/v6/prehandlers/{prehandlerId}"

	payload := strings.NewReader("{\n  \"actions\": [\n    {\n      \"expression\": {},\n      \"type\": \"EXPRESSION\"\n    }\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"conditions\": [\n    {\n      \"considered_block_list_types\": [\n        \"CIDR\"\n      ],\n      \"type\": \"BLOCK_MATCH\"\n    }\n  ],\n  \"description\": \"description\",\n  \"enabled\": true,\n  \"name\": \"name\",\n  \"order\": 1,\n  \"tags\": [\n    \"tag\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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.put("https://api.extole.io/v6/prehandlers/{prehandlerId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actions\": [\n    {\n      \"expression\": {},\n      \"type\": \"EXPRESSION\"\n    }\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"conditions\": [\n    {\n      \"considered_block_list_types\": [\n        \"CIDR\"\n      ],\n      \"type\": \"BLOCK_MATCH\"\n    }\n  ],\n  \"description\": \"description\",\n  \"enabled\": true,\n  \"name\": \"name\",\n  \"order\": 1,\n  \"tags\": [\n    \"tag\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/prehandlers/{prehandlerId}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"actions\": [\n    {\n      \"expression\": {},\n      \"type\": \"EXPRESSION\"\n    }\n  ],\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"conditions\": [\n    {\n      \"considered_block_list_types\": [\n        \"CIDR\"\n      ],\n      \"type\": \"BLOCK_MATCH\"\n    }\n  ],\n  \"description\": \"description\",\n  \"enabled\": true,\n  \"name\": \"name\",\n  \"order\": 1,\n  \"tags\": [\n    \"tag\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "actions": [
    {
      "id": "<string>",
      "type": "EXPRESSION",
      "expression": {}
    }
  ],
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "conditions": [
    {
      "id": "<string>",
      "type": "BLOCK_MATCH",
      "considered_block_list_types": []
    }
  ],
  "created_date": "2025-10-24T02:00:00-07:00",
  "description": "<string>",
  "enabled": true,
  "id": "<string>",
  "name": "<string>",
  "order": 123,
  "tags": [
    "<string>"
  ],
  "updated_date": "2025-10-24T02:00:00-07:00"
}

Authorizations

Authorization

string

header

required

Path Parameters

prehandlerId

string

required

The id of the prehandler to be updated.

Body

application/json

PrehandlerUpdateRequest object

Body of a PUT /v6/prehandlers/{prehandlerId} request.

actions

(EXPRESSION · object | JAVASCRIPT_V1 · object | MAP_DATA_ATTRIBUTES · object | SET_DATA · object | SET_SANDBOX · object)[]

Action represented by expression that can change the event.

EXPRESSION
JAVASCRIPT_V1
MAP_DATA_ATTRIBUTES
SET_DATA
SET_SANDBOX

Show child attributes

component_ids

string[]

component_references

object[]

Show child attributes

conditions

Condition that adds the block list types to be checked.

Show child attributes

description

Choose between static or dynamic description

enabled

Choose between static or dynamic enabled

name

Prehandler name must be unique.

order

Choose between static or dynamic order

Response

Prehandler source definition with build-time fields, conditions, actions, execution order, and component references.

Prehandler source definition with build-time fields, conditions, actions, and execution order.

actions

(EXPRESSION · object | JAVASCRIPT_V1 · object | MAP_DATA_ATTRIBUTES · object | SET_DATA · object | SET_SANDBOX · object)[]

required

Actions executed when the prehandler conditions match.

EXPRESSION
JAVASCRIPT_V1
MAP_DATA_ATTRIBUTES
SET_DATA
SET_SANDBOX

Show child attributes

component_ids

string[]

required

component_references

object[]

required

Show child attributes

conditions

required

Conditions that must match before the prehandler actions run.

Show child attributes

created_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

description

required

Optional build-time expression that resolves to the prehandler description.

enabled

required

Build-time expression that controls whether the prehandler is active.

string

required

read-only

Unique identifier for the prehandler.

name

required

Build-time expression that resolves to the prehandler name.

order

required

Build-time expression that controls the prehandler execution order.

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Update a prehandler

Authorizations

Path Parameters

Body

Response