Interceptors
Update interceptor
Updates an interceptor’s field mapping or response behavior.
PATCH
/
api
/
admin
/
interceptors
/
{id}
Update interceptor
curl --request PATCH \
--url https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"active": true,
"context": "<string>",
"description": "<string>",
"destination": {
"timeout_ms": 123,
"url": "<string>"
},
"field_mapping": [
{}
],
"responses": {}
}
'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}"
payload = {
"active": True,
"context": "<string>",
"description": "<string>",
"destination": {
"timeout_ms": 123,
"url": "<string>"
},
"field_mapping": [{}],
"responses": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
active: true,
context: '<string>',
description: '<string>',
destination: {timeout_ms: 123, url: '<string>'},
field_mapping: [{}],
responses: {}
})
};
fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}', 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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}",
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([
'active' => true,
'context' => '<string>',
'description' => '<string>',
'destination' => [
'timeout_ms' => 123,
'url' => '<string>'
],
'field_mapping' => [
[
]
],
'responses' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}"
payload := strings.NewReader("{\n \"active\": true,\n \"context\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"timeout_ms\": 123,\n \"url\": \"<string>\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"context\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"timeout_ms\": 123,\n \"url\": \"<string>\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true,\n \"context\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"timeout_ms\": 123,\n \"url\": \"<string>\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context": "<string>",
"description": "<string>",
"destination": {
"timeout_ms": 30000,
"url": "https://checkout.example.com/payments"
},
"discovered_keys": [
{
"key": "<string>",
"type": "<string>"
}
],
"field_mapping": [
{}
],
"inserted_at": "2023-11-07T05:31:56Z",
"ref": "<string>",
"responses": {},
"updated_at": "2023-11-07T05:31:56Z",
"version": 123
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "VALIDATION_ERROR",
"code": 422,
"validation_errors": [
{
"message": "must be a positive integer",
"path": "limit"
}
]
}Authorizations
HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).
Path Parameters
Body
application/json
Update attributes
Response
Updated interceptor
Show child attributes
Show child attributes
Typed JSONPath keys observed in intercepted requests. Used for field mapping discovery.
Show child attributes
Show child attributes
Stable identifier shared across all versions of this interceptor. Used as the path parameter for the runtime execute endpoint.
Available options:
DRAFT, ACTIVE, INACTIVE ⌘I
Update interceptor
curl --request PATCH \
--url https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"active": true,
"context": "<string>",
"description": "<string>",
"destination": {
"timeout_ms": 123,
"url": "<string>"
},
"field_mapping": [
{}
],
"responses": {}
}
'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}"
payload = {
"active": True,
"context": "<string>",
"description": "<string>",
"destination": {
"timeout_ms": 123,
"url": "<string>"
},
"field_mapping": [{}],
"responses": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
active: true,
context: '<string>',
description: '<string>',
destination: {timeout_ms: 123, url: '<string>'},
field_mapping: [{}],
responses: {}
})
};
fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}', 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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}",
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([
'active' => true,
'context' => '<string>',
'description' => '<string>',
'destination' => [
'timeout_ms' => 123,
'url' => '<string>'
],
'field_mapping' => [
[
]
],
'responses' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}"
payload := strings.NewReader("{\n \"active\": true,\n \"context\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"timeout_ms\": 123,\n \"url\": \"<string>\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"context\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"timeout_ms\": 123,\n \"url\": \"<string>\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/interceptors/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"active\": true,\n \"context\": \"<string>\",\n \"description\": \"<string>\",\n \"destination\": {\n \"timeout_ms\": 123,\n \"url\": \"<string>\"\n },\n \"field_mapping\": [\n {}\n ],\n \"responses\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context": "<string>",
"description": "<string>",
"destination": {
"timeout_ms": 30000,
"url": "https://checkout.example.com/payments"
},
"discovered_keys": [
{
"key": "<string>",
"type": "<string>"
}
],
"field_mapping": [
{}
],
"inserted_at": "2023-11-07T05:31:56Z",
"ref": "<string>",
"responses": {},
"updated_at": "2023-11-07T05:31:56Z",
"version": 123
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "VALIDATION_ERROR",
"code": 422,
"validation_errors": [
{
"message": "must be a positive integer",
"path": "limit"
}
]
}