Update template

PUT {{baseUrl}}/templates/:id?aid=1234

Updates an existing template. This operation overwrites the existing template object with the object sent in the request. If a partial update is required, it is recommended that you retrieve the template and modify the template object before updating it.

Request Params

Key	Datatype	Required	Description
`aid`	number		A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.

Request Body

{"name"=>"My Template", "description"=>"A description of My Template", "icon"=>"server", "isBuiltIn"=>false, "certificationLevel"=>"user", "userInputs"=>{"targetDomain"=>{"name"=>"Target Domain", "description"=>"Name of target domain that will be used for configuring tests in this template.", "type"=>"string"}, "region"=>{"name"=>"Cloud Region", "description"=>"The available cloud regions to target.", "type"=>"string", "allowedValues"=>[{"name"=>"West", "value"=>"us-west-1"}, {"name"=>"East", "value"=>"us-east-2"}]}, "agents"=>{"name"=>"Source Agents", "description"=>"The agents that will be used by the tests in this template.", "type"=>"agents"}}, "labels"=>{"dolore_f_f"=>{"name"=>"qui culpa dolor labore", "type"=>"tests", "tests"=>[{"testId"=>"dolore"}, {"testId"=>"nisi reprehenderit com"}], "endpointTests"=>[{"testId"=>"Excepteur fugiat"}, {"testId"=>"fugiat sint"}]}, "dolor_7"=>{"name"=>"elit deserunt consequat", "type"=>"tests", "tests"=>[{"testId"=>"minim"}, {"testId"=>"in officia est incididunt in"}], "endpointTests"=>[{"testId"=>"velit tempor"}, {"testId"=>"Excepteur sint Ut"}]}, "Ut8"=>{"name"=>"dolore velit fugiat", "type"=>"tests", "tests"=>[{"testId"=>"ea fugiat do velit culpa"}, {"testId"=>"sed exercitat"}], "endpointTests"=>[{"testId"=>"sed ut nulla consequat adipisicing"}, {"testId"=>"minim"}]}}, "tests"=>{"sed6"=>{"agents"=>[{"agentId"=>-30077026.76788795}, {"agentId"=>-25738147.87234357}], "interval"=>60, "server"=>"voluptate Duis Excepteur dolor", "testName"=>"cupidatat ullamco id", "type"=>"http-server", "groups"=>[{"groupId"=>8568122.815298066}, {"groupId"=>55076127.07494992}], "description"=>"irure aute fugiat ullamco", "port"=>12146192, "bgpMeasurements"=>0, "bandwidthMeasurements"=>0, "mtuMeasurements"=>0, "numPathTraces"=>3, "pathTraceMode"=>"classic", "probeMode"=>"AUTO", "protocol"=>"TCP", "continuousMode"=>0, "fixedPacketRate"=>0}, "pariatur86c"=>{"agents"=>[{"agentId"=>-40875807.46558257}, {"agentId"=>-32971846.655617476}], "interval"=>60, "server"=>"cul", "testName"=>"irure deserunt", "type"=>"http-server", "groups"=>[{"groupId"=>-63261159.64227524}, {"groupId"=>-99968411.7738362}], "description"=>"dolor Excepteur", "port"=>26232651, "bgpMeasurements"=>0, "bandwidthMeasurements"=>0, "mtuMeasurements"=>0, "numPathTraces"=>3, "pathTraceMode"=>"classic", "probeMode"=>"AUTO", "protocol"=>"TCP", "continuousMode"=>0, "fixedPacketRate"=>0}}, "endpointTests"=>{"est3"=>{"genericConfig"=>{"interval"=>60, "priority"=>77390550}, "machineConfig"=>{"maxMachines"=>-14383408, "monitoringSettingsType"=>"ANY_AGENT", "agentIds"=>["in deserunt eu", "consequat in irure non"], "labelIds"=>[-4283138, -48103687]}, "networkConfig"=>{"flagPing"=>true, "flagTraceroute"=>true, "ipVersion"=>"V4_ONLY", "networkProtocol"=>"AUTODETECT", "pathtraceInSession"=>false, "tcpConnect"=>false, "tcpProbeMode"=>"SACK"}, "testCategory"=>"SCHEDULED_TEST", "testType"=>"Http", "testName"=>"nisi laborum", "description"=>"pariatur", "flagEnabled"=>true, "alertRules"=>[{"ruleId"=>-21649042}, {"ruleId"=>58787102}], "server"=>{"port"=>80, "serverName"=>"www.example.com"}, "httpConfig"=>{"httpTimeLimit"=>26822, "sslVersion"=>5, "targetFetchTime"=>-46512974, "targetResponseTime"=>-5863141, "url"=>"https://meet.google.com", "verifyCertHostname"=>false, "headers"=>"sit laborum exercitation", "authType"=>"BASIC", "bytesToDownload"=>89743830, "username"=>"id officia reprehenderit", "password"=>"nisi anim", "postBody"=>"anim esse", "contentRegex"=>"laboris ex", "expectedResponseCode"=>40544273, "targetIpOverride"=>"et ex", "clientCert"=>"velit qui dolor voluptate anim", "userAgent"=>"nostrud sunt", "maxRedirects"=>15813871, "proxyId"=>1168591, "proxyDirect"=>false}, "testLabelIds"=>[19124399.63119863, 31981797.76254925]}, "ut_583"=>{"genericConfig"=>{"interval"=>60, "priority"=>-23769352}, "machineConfig"=>{"maxMachines"=>-14039088, "monitoringSettingsType"=>"ANY_AGENT", "agentIds"=>["ut veniam eu elit", "est exercitation fugiat Duis deserunt"], "labelIds"=>[-17888331, -91449660]}, "networkConfig"=>{"flagPing"=>true, "flagTraceroute"=>true, "ipVersion"=>"V4_ONLY", "networkProtocol"=>"AUTODETECT", "pathtraceInSession"=>false, "tcpConnect"=>false, "tcpProbeMode"=>"SACK"}, "testCategory"=>"SCHEDULED_TEST", "testType"=>"Http", "testName"=>"enim nulla cillum tempor", "description"=>"in irure adipisicing in mollit", "flagEnabled"=>true, "alertRules"=>[{"ruleId"=>78614725}, {"ruleId"=>-91340143}], "server"=>{"port"=>80, "serverName"=>"www.example.com"}, "httpConfig"=>{"httpTimeLimit"=>50966, "sslVersion"=>2, "targetFetchTime"=>98834189, "targetResponseTime"=>8662468, "url"=>"https://meet.google.com", "verifyCertHostname"=>true, "headers"=>"anim Ut", "authType"=>"BASIC", "bytesToDownload"=>3897948, "username"=>"exercitation Ut enim ex", "password"=>"non voluptate exerc", "postBody"=>"sed culpa irure", "contentRegex"=>"eu", "expectedResponseCode"=>-9309620, "targetIpOverride"=>"repr", "clientCert"=>"dolore esse consectetur labore", "userAgent"=>"fugiat in reprehenderit ipsum", "maxRedirects"=>52877158, "proxyId"=>441187, "proxyDirect"=>false}, "testLabelIds"=>[5108833.239325434, -94985086.05243003]}, "labore2d"=>{"genericConfig"=>{"interval"=>60, "priority"=>36401740}, "machineConfig"=>{"maxMachines"=>-61694627, "monitoringSettingsType"=>"ANY_AGENT", "agentIds"=>["labore ipsum sed amet esse", "eu"], "labelIds"=>[-83922642, 6688672]}, "networkConfig"=>{"flagPing"=>true, "flagTraceroute"=>true, "ipVersion"=>"V4_ONLY", "networkProtocol"=>"AUTODETECT", "pathtraceInSession"=>false, "tcpConnect"=>false, "tcpProbeMode"=>"SACK"}, "testCategory"=>"SCHEDULED_TEST", "testType"=>"Http", "testName"=>"et quis lab", "description"=>"Duis dolore exercitation laboris", "flagEnabled"=>false, "alertRules"=>[{"ruleId"=>-21865984}, {"ruleId"=>-74230338}], "server"=>{"port"=>80, "serverName"=>"www.example.com"}, "httpConfig"=>{"httpTimeLimit"=>22376, "sslVersion"=>2, "targetFetchTime"=>-55127471, "targetResponseTime"=>-52394426, "url"=>"https://meet.google.com", "verifyCertHostname"=>false, "headers"=>"enim", "authType"=>"BASIC", "bytesToDownload"=>69868719, "username"=>"ex aute commodo", "password"=>"ut est", "postBody"=>"sint", "contentRegex"=>"tempor", "expectedResponseCode"=>-821809, "targetIpOverride"=>"Ut ut aliquip proident", "clientCert"=>"mollit occae", "userAgent"=>"dolore culpa tempor", "maxRedirects"=>-81788255, "proxyId"=>-12040506, "proxyDirect"=>false}, "testLabelIds"=>[-15057940.592622682, 78513935.5141741]}}, "alertRules"=>{"httpAlert"=>{"alertType"=>"HTTP Server", "ruleName"=>"{{userInputs.tenantName}} - Alert Rule", "expression"=>"((totalTime >= 500 ms) && (responseTime >= 500 ms))", "roundsViolatingRequired"=>1, "roundsViolatingOutOf"=>1, "testIds"=>["{{tests.pageLoadTest.testId}}"]}}, "dashboards"=>{"laborum_914"=>{"title"=>"sit commodo labore consequat", "description"=>"conse", "globalFilterId"=>"magna laborum ", "widgets"=>[{"title"=>"ullamco al", "type"=>"Test Table", "visualMode"=>"Full", "metricGroup"=>"BGP", "direction"=>"FROM_TARGET", "metric"=>"ENDPOINT_GATEWAY_CPU_LOAD_PERCENT", "filters"=>{"TEST"=>[5187, 5227], "ENDPOINT_MACHINE_ID"=>["fbd0050c-07f7-43f7-9631-14b32f096962"]}, "measure"=>{"type"=>"MEAN", "percentileValue"=>95}, "fixedTimespan"=>{"value"=>10, "unit"=>"Days"}, "shouldExcludeAlertSuppressionWindows"=>false}, {"title"=>"cupidatat", "type"=>"Color Grid", "visualMode"=>"Full", "metricGroup"=>"BGP", "direction"=>"FROM_TARGET", "metric"=>"ENDPOINT_GATEWAY_CPU_LOAD_PERCENT", "filters"=>{"TEST"=>[5187, 5227], "ENDPOINT_MACHINE_ID"=>["fbd0050c-07f7-43f7-9631-14b32f096962"]}, "measure"=>{"type"=>"MEAN", "percentileValue"=>95}, "fixedTimespan"=>{"value"=>10, "unit"=>"Days"}, "shouldExcludeAlertSuppressionWindows"=>true}], "refreshRate"=>"false"}}, "dashboardFilters"=>{"netHealthDashboardFilter"=>{"name"=>"{{userInputs.dashboardFilterTitle}}", "context"=>[{"dataSourceId"=>"VIRTUAL_AGENT", "filters"=>[{"filterId"=>"TEST_LABEL", "metricIds"=>["NET_LOSS", "NET_LATENCY", "NET_JITTER"], "values"=>["{{labels.testLabel.groupId}}"]}]}]}}, "deploymentStrategy"=>{"testVoiceLabel"=>"update", "testVideoLabel"=>"update", "testLabel"=>"update", "dnsTest"=>"ignore", "webexDashboard"=>"ignore", "serverTest"=>"create"}, "modules"=>["default"]}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string
`Accept`	string

RESPONSES

status: OK

{&quot;name&quot;:&quot;My Template&quot;,&quot;id&quot;:&quot;fcbb89a7-61cf-4616-9c4f-828fa3cb4684&quot;,&quot;dateCreated&quot;:&quot;2023-07-17T22:00:54Z&quot;,&quot;description&quot;:&quot;A description of My Template&quot;,&quot;icon&quot;:&quot;server&quot;,&quot;isBuiltIn&quot;:false,&quot;certificationLevel&quot;:&quot;user&quot;,&quot;userInputs&quot;:{&quot;targetDomain&quot;:{&quot;name&quot;:&quot;Target Domain&quot;,&quot;description&quot;:&quot;Name of target domain that will be used for configuring tests in this template.&quot;,&quot;type&quot;:&quot;string&quot;},&quot;region&quot;:{&quot;name&quot;:&quot;Cloud Region&quot;,&quot;description&quot;:&quot;The available cloud regions to target.&quot;,&quot;type&quot;:&quot;string&quot;,&quot;allowedValues&quot;:[{&quot;name&quot;:&quot;West&quot;,&quot;value&quot;:&quot;us-west-1&quot;},{&quot;name&quot;:&quot;East&quot;,&quot;value&quot;:&quot;us-east-2&quot;}]},&quot;agents&quot;:{&quot;name&quot;:&quot;Source Agents&quot;,&quot;description&quot;:&quot;The agents that will be used by the tests in this template.&quot;,&quot;type&quot;:&quot;agents&quot;}},&quot;labels&quot;:{&quot;dolore_9ac&quot;:{&quot;name&quot;:&quot;amet elit exercitation lab&quot;,&quot;type&quot;:&quot;tests&quot;,&quot;tests&quot;:[{&quot;testId&quot;:&quot;irure do dolore&quot;},{&quot;testId&quot;:&quot;voluptate Excepteur ea&quot;}],&quot;endpointTests&quot;:[{&quot;testId&quot;:&quot;fugiat velit nostrud&quot;},{&quot;testId&quot;:&quot;ut exercitation elit&quot;}]},&quot;velita17&quot;:{&quot;name&quot;:&quot;dolor do culpa in&quot;,&quot;type&quot;:&quot;tests&quot;,&quot;tests&quot;:[{&quot;testId&quot;:&quot;aliqua tempor de&quot;},{&quot;testId&quot;:&quot;deserunt ipsum sed&quot;}],&quot;endpointTests&quot;:[{&quot;testId&quot;:&quot;id&quot;},{&quot;testId&quot;:&quot;eiusmod enim Excepteur&quot;}]}},&quot;tests&quot;:{&quot;adipisicing_e&quot;:{&quot;agents&quot;:[{&quot;agentId&quot;:78269894.63059258},{&quot;agentId&quot;:54135674.45486817}],&quot;interval&quot;:60,&quot;server&quot;:&quot;anim sint non&quot;,&quot;testName&quot;:&quot;laboris esse&quot;,&quot;type&quot;:&quot;http-server&quot;,&quot;groups&quot;:[{&quot;groupId&quot;:23561620.429320753},{&quot;groupId&quot;:62241899.87751219}],&quot;description&quot;:&quot;sunt exercitation voluptate&quot;,&quot;port&quot;:33590493,&quot;bgpMeasurements&quot;:0,&quot;bandwidthMeasurements&quot;:0,&quot;mtuMeasurements&quot;:0,&quot;numPathTraces&quot;:3,&quot;pathTraceMode&quot;:&quot;classic&quot;,&quot;probeMode&quot;:&quot;AUTO&quot;,&quot;protocol&quot;:&quot;TCP&quot;,&quot;continuousMode&quot;:0,&quot;fixedPacketRate&quot;:0},&quot;ex_8&quot;:{&quot;agents&quot;:[{&quot;agentId&quot;:-75256907.71236628},{&quot;agentId&quot;:72841235.2775662}],&quot;interval&quot;:60,&quot;server&quot;:&quot;Ut occaecat&quot;,&quot;testName&quot;:&quot;aliquip et&quot;,&quot;type&quot;:&quot;http-server&quot;,&quot;groups&quot;:[{&quot;groupId&quot;:16692341.520655066},{&quot;groupId&quot;:-14656512.404159412}],&quot;description&quot;:&quot;Excep&quot;,&quot;port&quot;:-40559641,&quot;bgpMeasurements&quot;:0,&quot;bandwidthMeasurements&quot;:0,&quot;mtuMeasurements&quot;:0,&quot;numPathTraces&quot;:3,&quot;pathTraceMode&quot;:&quot;classic&quot;,&quot;probeMode&quot;:&quot;AUTO&quot;,&quot;protocol&quot;:&quot;TCP&quot;,&quot;continuousMode&quot;:0,&quot;fixedPacketRate&quot;:0},&quot;officia_c&quot;:{&quot;agents&quot;:[{&quot;agentId&quot;:-9561831.676358461},{&quot;agentId&quot;:88227880.05539027}],&quot;interval&quot;:60,&quot;server&quot;:&quot;dolor sed nulla&quot;,&quot;testName&quot;:&quot;aliqua&quot;,&quot;type&quot;:&quot;http-server&quot;,&quot;groups&quot;:[{&quot;groupId&quot;:-31090401.595557183},{&quot;groupId&quot;:43208020.778699875}],&quot;description&quot;:&quot;Ut est&quot;,&quot;port&quot;:95538558,&quot;bgpMeasurements&quot;:0,&quot;bandwidthMeasurements&quot;:0,&quot;mtuMeasurements&quot;:0,&quot;numPathTraces&quot;:3,&quot;pathTraceMode&quot;:&quot;classic&quot;,&quot;probeMode&quot;:&quot;AUTO&quot;,&quot;protocol&quot;:&quot;TCP&quot;,&quot;continuousMode&quot;:0,&quot;fixedPacketRate&quot;:0}},&quot;endpointTests&quot;:{&quot;aliqua2a3&quot;:{&quot;genericConfig&quot;:{&quot;interval&quot;:60,&quot;priority&quot;:64414061},&quot;machineConfig&quot;:{&quot;maxMachines&quot;:62984618,&quot;monitoringSettingsType&quot;:&quot;ANY_AGENT&quot;,&quot;agentIds&quot;:[&quot;nisi &quot;,&quot;sunt aliqua exercitation&quot;],&quot;labelIds&quot;:[-79493638,54984276]},&quot;networkConfig&quot;:{&quot;flagPing&quot;:true,&quot;flagTraceroute&quot;:true,&quot;ipVersion&quot;:&quot;V4_ONLY&quot;,&quot;networkProtocol&quot;:&quot;AUTODETECT&quot;,&quot;pathtraceInSession&quot;:true,&quot;tcpConnect&quot;:false,&quot;tcpProbeMode&quot;:&quot;SACK&quot;},&quot;testCategory&quot;:&quot;SCHEDULED_TEST&quot;,&quot;testType&quot;:&quot;Http&quot;,&quot;testName&quot;:&quot;reprehenderit&quot;,&quot;description&quot;:&quot;officia nulla dolor&quot;,&quot;flagEnabled&quot;:true,&quot;alertRules&quot;:[{&quot;ruleId&quot;:-7147435},{&quot;ruleId&quot;:-56942394}],&quot;server&quot;:{&quot;port&quot;:80,&quot;serverName&quot;:&quot;www.example.com&quot;},&quot;httpConfig&quot;:{&quot;httpTimeLimit&quot;:27707,&quot;sslVersion&quot;:0,&quot;targetFetchTime&quot;:60890537,&quot;targetResponseTime&quot;:-212306,&quot;url&quot;:&quot;https://meet.google.com&quot;,&quot;verifyCertHostname&quot;:true,&quot;headers&quot;:&quot;elit enim&quot;,&quot;authType&quot;:&quot;BASIC&quot;,&quot;bytesToDownload&quot;:-37140844,&quot;username&quot;:&quot;anim occaecat veniam&quot;,&quot;password&quot;:&quot;incididunt voluptate consequat&quot;,&quot;postBody&quot;:&quot;fugiat nisi exercitation&quot;,&quot;contentRegex&quot;:&quot;t&quot;,&quot;expectedResponseCode&quot;:-80061286,&quot;targetIpOverride&quot;:&quot;ut adipisicing&quot;,&quot;clientCert&quot;:&quot;labore&quot;,&quot;userAgent&quot;:&quot;est culpa labore&quot;,&quot;maxRedirects&quot;:30912657,&quot;proxyId&quot;:-26900350,&quot;proxyDirect&quot;:false},&quot;testLabelIds&quot;:[-42492799.87481747,45398507.753878534]}},&quot;alertRules&quot;:{&quot;httpAlert&quot;:{&quot;alertType&quot;:&quot;HTTP Server&quot;,&quot;ruleName&quot;:&quot;{{userInputs.tenantName}} - Alert Rule&quot;,&quot;expression&quot;:&quot;((totalTime \u003e= 500 ms) \u0026\u0026 (responseTime \u003e= 500 ms))&quot;,&quot;roundsViolatingRequired&quot;:1,&quot;roundsViolatingOutOf&quot;:1,&quot;testIds&quot;:[&quot;{{tests.pageLoadTest.testId}}&quot;]}},&quot;dashboards&quot;:{&quot;in708&quot;:{&quot;title&quot;:&quot;aliquip officia cupidatat ipsum&quot;,&quot;description&quot;:&quot;cillum&quot;,&quot;globalFilterId&quot;:&quot;nostrud exercitation &quot;,&quot;widgets&quot;:[{&quot;title&quot;:&quot;sed&quot;,&quot;type&quot;:&quot;Multi Metric Table&quot;,&quot;visualMode&quot;:&quot;Full&quot;,&quot;metricGroup&quot;:&quot;BGP&quot;,&quot;direction&quot;:&quot;FROM_TARGET&quot;,&quot;metric&quot;:&quot;ENDPOINT_GATEWAY_CPU_LOAD_PERCENT&quot;,&quot;filters&quot;:{&quot;TEST&quot;:[5187,5227],&quot;ENDPOINT_MACHINE_ID&quot;:[&quot;fbd0050c-07f7-43f7-9631-14b32f096962&quot;]},&quot;measure&quot;:{&quot;type&quot;:&quot;MEAN&quot;,&quot;percentileValue&quot;:95},&quot;fixedTimespan&quot;:{&quot;value&quot;:10,&quot;unit&quot;:&quot;Days&quot;},&quot;shouldExcludeAlertSuppressionWindows&quot;:true},{&quot;title&quot;:&quot;ea elit si&quot;,&quot;type&quot;:&quot;Alert List&quot;,&quot;visualMode&quot;:&quot;Full&quot;,&quot;metricGroup&quot;:&quot;BGP&quot;,&quot;direction&quot;:&quot;FROM_TARGET&quot;,&quot;metric&quot;:&quot;ENDPOINT_GATEWAY_CPU_LOAD_PERCENT&quot;,&quot;filters&quot;:{&quot;TEST&quot;:[5187,5227],&quot;ENDPOINT_MACHINE_ID&quot;:[&quot;fbd0050c-07f7-43f7-9631-14b32f096962&quot;]},&quot;measure&quot;:{&quot;type&quot;:&quot;MEAN&quot;,&quot;percentileValue&quot;:95},&quot;fixedTimespan&quot;:{&quot;value&quot;:10,&quot;unit&quot;:&quot;Days&quot;},&quot;shouldExcludeAlertSuppressionWindows&quot;:true}],&quot;refreshRate&quot;:&quot;false&quot;}},&quot;dashboardFilters&quot;:{&quot;netHealthDashboardFilter&quot;:{&quot;name&quot;:&quot;{{userInputs.dashboardFilterTitle}}&quot;,&quot;context&quot;:[{&quot;dataSourceId&quot;:&quot;VIRTUAL_AGENT&quot;,&quot;filters&quot;:[{&quot;filterId&quot;:&quot;TEST_LABEL&quot;,&quot;metricIds&quot;:[&quot;NET_LOSS&quot;,&quot;NET_LATENCY&quot;,&quot;NET_JITTER&quot;],&quot;values&quot;:[&quot;{{labels.testLabel.groupId}}&quot;]}]}]}},&quot;deploymentStrategy&quot;:{&quot;testVoiceLabel&quot;:&quot;update&quot;,&quot;testVideoLabel&quot;:&quot;update&quot;,&quot;testLabel&quot;:&quot;update&quot;,&quot;dnsTest&quot;:&quot;ignore&quot;,&quot;webexDashboard&quot;:&quot;ignore&quot;,&quot;serverTest&quot;:&quot;create&quot;},&quot;modules&quot;:[&quot;default&quot;],&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;https://api.thousandeyes.com/v7/link/to/resource/id&quot;,&quot;templated&quot;:false,&quot;type&quot;:&quot;et Excepteur&quot;,&quot;deprecation&quot;:&quot;ipsum ut magna&quot;,&quot;name&quot;:&quot;laboris n&quot;,&quot;profile&quot;:&quot;dolore&quot;,&quot;title&quot;:&quot;culpa dolore labore ex&quot;,&quot;hreflang&quot;:&quot;aliqua est ex&quot;}}}