curl --request PUT \
--url https://api.extole.io/v1/client-domain-patterns/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"client_domain_id": {},
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"pattern": "pattern",
"test": true,
"type": "DOMAIN"
}
'import requests
url = "https://api.extole.io/v1/client-domain-patterns/{id}"
payload = {
"client_domain_id": {},
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"pattern": "pattern",
"test": True,
"type": "DOMAIN"
}
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({
client_domain_id: {},
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
pattern: 'pattern',
test: true,
type: 'DOMAIN'
})
};
fetch('https://api.extole.io/v1/client-domain-patterns/{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://api.extole.io/v1/client-domain-patterns/{id}",
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([
'client_domain_id' => [
],
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'pattern' => 'pattern',
'test' => true,
'type' => 'DOMAIN'
]),
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/v1/client-domain-patterns/{id}"
payload := strings.NewReader("{\n \"client_domain_id\": {},\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 \"pattern\": \"pattern\",\n \"test\": true,\n \"type\": \"DOMAIN\"\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/v1/client-domain-patterns/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"client_domain_id\": {},\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 \"pattern\": \"pattern\",\n \"test\": true,\n \"type\": \"DOMAIN\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/client-domain-patterns/{id}")
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 \"client_domain_id\": {},\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 \"pattern\": \"pattern\",\n \"test\": true,\n \"type\": \"DOMAIN\"\n}"
response = http.request(request)
puts response.read_body{
"client_domain_id": "<string>",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"id": "<string>",
"pattern": "<string>",
"test": true
}Update client domain pattern
Applies a partial update to the supplied domain pattern. Only the fields present in the body are changed; omitted fields are left intact. Returns the updated pattern record on success. Returns 400 client_domain_pattern_not_found if the id does not exist.
curl --request PUT \
--url https://api.extole.io/v1/client-domain-patterns/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"client_domain_id": {},
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"pattern": "pattern",
"test": true,
"type": "DOMAIN"
}
'import requests
url = "https://api.extole.io/v1/client-domain-patterns/{id}"
payload = {
"client_domain_id": {},
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"pattern": "pattern",
"test": True,
"type": "DOMAIN"
}
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({
client_domain_id: {},
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
pattern: 'pattern',
test: true,
type: 'DOMAIN'
})
};
fetch('https://api.extole.io/v1/client-domain-patterns/{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://api.extole.io/v1/client-domain-patterns/{id}",
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([
'client_domain_id' => [
],
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'pattern' => 'pattern',
'test' => true,
'type' => 'DOMAIN'
]),
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/v1/client-domain-patterns/{id}"
payload := strings.NewReader("{\n \"client_domain_id\": {},\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 \"pattern\": \"pattern\",\n \"test\": true,\n \"type\": \"DOMAIN\"\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/v1/client-domain-patterns/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"client_domain_id\": {},\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 \"pattern\": \"pattern\",\n \"test\": true,\n \"type\": \"DOMAIN\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/client-domain-patterns/{id}")
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 \"client_domain_id\": {},\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 \"pattern\": \"pattern\",\n \"test\": true,\n \"type\": \"DOMAIN\"\n}"
response = http.request(request)
puts response.read_body{
"client_domain_id": "<string>",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"id": "<string>",
"pattern": "<string>",
"test": true
}Authorizations
Path Parameters
Identifier of the client domain pattern to update.
Body
Body of a PUT /v1/client-domain-patterns/{id} request.
Show child attributes
Show child attributes
Choose between static or dynamic pattern
Choose between static or dynamic test
DOMAIN, GLOB, SUB_DOMAIN Response
Client domain pattern source definition with its build-time pattern expression, domain type, and component references.
Client domain pattern source definition with build-time expressions and component references.
Optional program domain identifier associated with this pattern.
Show child attributes
Show child attributes
Unique identifier for the client domain pattern.
Build-time expression that resolves to the domain pattern used for matching.
Build-time expression that marks whether the pattern is used for test traffic only.
Pattern matching type that controls how the pattern is interpreted.
DOMAIN, GLOB, SUB_DOMAIN 