Update a job
curl --request PUT \
--url https://api.extole.io/v6/jobs/{jobId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"enabled": true,
"name": "name",
"tasks": [
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"expected_headers": [
"expected_header"
],
"match_mode": "EXACT_SET",
"on_mismatch": "FAIL",
"order": 1,
"parent_job_id": "parent_job_id",
"task_type": "FILE_HEADER_VALIDATOR"
}
],
"triggers": [
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"match_type": "EXACT",
"parent_job_id": "parent_job_id",
"pattern": "pattern",
"trigger_type": "FILE_NAME_MATCHES"
}
]
}
'import requests
url = "https://api.extole.io/v6/jobs/{jobId}"
payload = {
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"enabled": True,
"name": "name",
"tasks": [
{
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"expected_headers": ["expected_header"],
"match_mode": "EXACT_SET",
"on_mismatch": "FAIL",
"order": 1,
"parent_job_id": "parent_job_id",
"task_type": "FILE_HEADER_VALIDATOR"
}
],
"triggers": [
{
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"match_type": "EXACT",
"parent_job_id": "parent_job_id",
"pattern": "pattern",
"trigger_type": "FILE_NAME_MATCHES"
}
]
}
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({
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
enabled: true,
name: 'name',
tasks: [
{
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
expected_headers: ['expected_header'],
match_mode: 'EXACT_SET',
on_mismatch: 'FAIL',
order: 1,
parent_job_id: 'parent_job_id',
task_type: 'FILE_HEADER_VALIDATOR'
}
],
triggers: [
{
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
match_type: 'EXACT',
parent_job_id: 'parent_job_id',
pattern: 'pattern',
trigger_type: 'FILE_NAME_MATCHES'
}
]
})
};
fetch('https://api.extole.io/v6/jobs/{jobId}', 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/jobs/{jobId}",
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([
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'enabled' => true,
'name' => 'name',
'tasks' => [
[
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'expected_headers' => [
'expected_header'
],
'match_mode' => 'EXACT_SET',
'on_mismatch' => 'FAIL',
'order' => 1,
'parent_job_id' => 'parent_job_id',
'task_type' => 'FILE_HEADER_VALIDATOR'
]
],
'triggers' => [
[
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'match_type' => 'EXACT',
'parent_job_id' => 'parent_job_id',
'pattern' => 'pattern',
'trigger_type' => 'FILE_NAME_MATCHES'
]
]
]),
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/jobs/{jobId}"
payload := strings.NewReader("{\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 \"enabled\": true,\n \"name\": \"name\",\n \"tasks\": [\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 \"expected_headers\": [\n \"expected_header\"\n ],\n \"match_mode\": \"EXACT_SET\",\n \"on_mismatch\": \"FAIL\",\n \"order\": 1,\n \"parent_job_id\": \"parent_job_id\",\n \"task_type\": \"FILE_HEADER_VALIDATOR\"\n }\n ],\n \"triggers\": [\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 \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\n }\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/jobs/{jobId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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 \"enabled\": true,\n \"name\": \"name\",\n \"tasks\": [\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 \"expected_headers\": [\n \"expected_header\"\n ],\n \"match_mode\": \"EXACT_SET\",\n \"on_mismatch\": \"FAIL\",\n \"order\": 1,\n \"parent_job_id\": \"parent_job_id\",\n \"task_type\": \"FILE_HEADER_VALIDATOR\"\n }\n ],\n \"triggers\": [\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 \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v6/jobs/{jobId}")
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 \"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 \"enabled\": true,\n \"name\": \"name\",\n \"tasks\": [\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 \"expected_headers\": [\n \"expected_header\"\n ],\n \"match_mode\": \"EXACT_SET\",\n \"on_mismatch\": \"FAIL\",\n \"order\": 1,\n \"parent_job_id\": \"parent_job_id\",\n \"task_type\": \"FILE_HEADER_VALIDATOR\"\n }\n ],\n \"triggers\": [\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 \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"client_id": "<string>",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"created_date": "2025-10-24T02:00:00-07:00",
"enabled": true,
"id": "<string>",
"name": "<string>",
"tasks": [
{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"id": "<string>",
"order": 123,
"parent_job_id": "<string>",
"task_type": "FILE_HEADER_VALIDATOR",
"expected_headers": [
"<string>"
],
"match_mode": "EXACT_SET",
"on_mismatch": "FAIL"
}
],
"triggers": [
{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"id": "<string>",
"parent_job_id": "<string>",
"trigger_type": "FILE_NAME_MATCHES",
"match_type": "EXACT",
"pattern": "<string>"
}
],
"updated_date": "2025-10-24T02:00:00-07:00"
}File Validation Monitors
Update a job
Updates top-level job fields. Trigger and task changes use the sub-endpoints.
PUT
/
v6
/
jobs
/
{jobId}
Update a job
curl --request PUT \
--url https://api.extole.io/v6/jobs/{jobId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"enabled": true,
"name": "name",
"tasks": [
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"expected_headers": [
"expected_header"
],
"match_mode": "EXACT_SET",
"on_mismatch": "FAIL",
"order": 1,
"parent_job_id": "parent_job_id",
"task_type": "FILE_HEADER_VALIDATOR"
}
],
"triggers": [
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"match_type": "EXACT",
"parent_job_id": "parent_job_id",
"pattern": "pattern",
"trigger_type": "FILE_NAME_MATCHES"
}
]
}
'import requests
url = "https://api.extole.io/v6/jobs/{jobId}"
payload = {
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"enabled": True,
"name": "name",
"tasks": [
{
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"expected_headers": ["expected_header"],
"match_mode": "EXACT_SET",
"on_mismatch": "FAIL",
"order": 1,
"parent_job_id": "parent_job_id",
"task_type": "FILE_HEADER_VALIDATOR"
}
],
"triggers": [
{
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"match_type": "EXACT",
"parent_job_id": "parent_job_id",
"pattern": "pattern",
"trigger_type": "FILE_NAME_MATCHES"
}
]
}
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({
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
enabled: true,
name: 'name',
tasks: [
{
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
expected_headers: ['expected_header'],
match_mode: 'EXACT_SET',
on_mismatch: 'FAIL',
order: 1,
parent_job_id: 'parent_job_id',
task_type: 'FILE_HEADER_VALIDATOR'
}
],
triggers: [
{
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
match_type: 'EXACT',
parent_job_id: 'parent_job_id',
pattern: 'pattern',
trigger_type: 'FILE_NAME_MATCHES'
}
]
})
};
fetch('https://api.extole.io/v6/jobs/{jobId}', 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/jobs/{jobId}",
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([
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'enabled' => true,
'name' => 'name',
'tasks' => [
[
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'expected_headers' => [
'expected_header'
],
'match_mode' => 'EXACT_SET',
'on_mismatch' => 'FAIL',
'order' => 1,
'parent_job_id' => 'parent_job_id',
'task_type' => 'FILE_HEADER_VALIDATOR'
]
],
'triggers' => [
[
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'match_type' => 'EXACT',
'parent_job_id' => 'parent_job_id',
'pattern' => 'pattern',
'trigger_type' => 'FILE_NAME_MATCHES'
]
]
]),
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/jobs/{jobId}"
payload := strings.NewReader("{\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 \"enabled\": true,\n \"name\": \"name\",\n \"tasks\": [\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 \"expected_headers\": [\n \"expected_header\"\n ],\n \"match_mode\": \"EXACT_SET\",\n \"on_mismatch\": \"FAIL\",\n \"order\": 1,\n \"parent_job_id\": \"parent_job_id\",\n \"task_type\": \"FILE_HEADER_VALIDATOR\"\n }\n ],\n \"triggers\": [\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 \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\n }\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/jobs/{jobId}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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 \"enabled\": true,\n \"name\": \"name\",\n \"tasks\": [\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 \"expected_headers\": [\n \"expected_header\"\n ],\n \"match_mode\": \"EXACT_SET\",\n \"on_mismatch\": \"FAIL\",\n \"order\": 1,\n \"parent_job_id\": \"parent_job_id\",\n \"task_type\": \"FILE_HEADER_VALIDATOR\"\n }\n ],\n \"triggers\": [\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 \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v6/jobs/{jobId}")
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 \"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 \"enabled\": true,\n \"name\": \"name\",\n \"tasks\": [\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 \"expected_headers\": [\n \"expected_header\"\n ],\n \"match_mode\": \"EXACT_SET\",\n \"on_mismatch\": \"FAIL\",\n \"order\": 1,\n \"parent_job_id\": \"parent_job_id\",\n \"task_type\": \"FILE_HEADER_VALIDATOR\"\n }\n ],\n \"triggers\": [\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 \"match_type\": \"EXACT\",\n \"parent_job_id\": \"parent_job_id\",\n \"pattern\": \"pattern\",\n \"trigger_type\": \"FILE_NAME_MATCHES\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"client_id": "<string>",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"created_date": "2025-10-24T02:00:00-07:00",
"enabled": true,
"id": "<string>",
"name": "<string>",
"tasks": [
{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"id": "<string>",
"order": 123,
"parent_job_id": "<string>",
"task_type": "FILE_HEADER_VALIDATOR",
"expected_headers": [
"<string>"
],
"match_mode": "EXACT_SET",
"on_mismatch": "FAIL"
}
],
"triggers": [
{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"id": "<string>",
"parent_job_id": "<string>",
"trigger_type": "FILE_NAME_MATCHES",
"match_type": "EXACT",
"pattern": "<string>"
}
],
"updated_date": "2025-10-24T02:00:00-07:00"
}Authorizations
HEADERQUERYCOOKIE
Path Parameters
Body
application/json
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Whether the job runs when triggered. A literal value or a buildtime expression resolved from component references when the job is saved. Buildtime expressions use JobBuildtimeContext.
Response
Successful response
Stored job definition. Field enabled is unevaluated and appears in buildtime-evaluatable form.
Show child attributes
Show child attributes
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"
enabled
Static Value · booleanBuildtime - Handlebars · stringBuildtime - Javascript · string
required
Whether the job runs when triggered. A literal value or a buildtime expression resolved from component references when the job is saved. Buildtime expressions use JobBuildtimeContext.
Stored task definition. Field order is unevaluated and appears in buildtime-evaluatable form.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Stored file name matches trigger definition. Fields match_type and pattern are unevaluated and appear in buildtime-evaluatable form.
- Option 1
- Option 2
Show child attributes
Show child attributes
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"
⌘I