Update Protect Settings
PUT {{apiPath}}/environments/{{envID}}/riskSettings
This request uses the riskSettings endpoint to modify the maximum data retention periods for the risk data that is used by the following predictors:
-
New Device
-
User Location Anomaly
-
User Base Risk Behavior
Note that when you modify the maximum data retention period, the new period applies only to the data collected after you changed the setting.
Request Model
Refer to Protect Settings for the complete data models.
Base data model
| Property | Type | Required? |
|---|---|---|
|
Object |
Required |
|
Integer |
Optional |
|
Integer |
Optional |
|
Integer |
Optional |
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/riskSettings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"dataRetention": {
"userLocationAnomalyInDays": 60,
"newDeviceInDays": 180,
"userBasedRiskBehaviorInDays": 90
}
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/riskSettings")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""dataRetention"": {" + "\n" +
@" ""userLocationAnomalyInDays"": 60," + "\n" +
@" ""newDeviceInDays"": 180," + "\n" +
@" ""userBasedRiskBehaviorInDays"": 90" + "\n" +
@" }" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/environments/{{envID}}/riskSettings"
method := "PUT"
payload := strings.NewReader(`{
"dataRetention": {
"userLocationAnomalyInDays": 60,
"newDeviceInDays": 180,
"userBasedRiskBehaviorInDays": 90
}
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {{accessToken}}")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
PUT /environments/{{envID}}/riskSettings HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"dataRetention": {
"userLocationAnomalyInDays": 60,
"newDeviceInDays": 180,
"userBasedRiskBehaviorInDays": 90
}
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"dataRetention\": {\n \"userLocationAnomalyInDays\": 60,\n \"newDeviceInDays\": 180,\n \"userBasedRiskBehaviorInDays\": 90\n }\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/riskSettings")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/riskSettings",
"method": "PUT",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"dataRetention": {
"userLocationAnomalyInDays": 60,
"newDeviceInDays": 180,
"userBasedRiskBehaviorInDays": 90
}
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'PUT',
'url': '{{apiPath}}/environments/{{envID}}/riskSettings',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"dataRetention": {
"userLocationAnomalyInDays": 60,
"newDeviceInDays": 180,
"userBasedRiskBehaviorInDays": 90
}
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/riskSettings"
payload = json.dumps({
"dataRetention": {
"userLocationAnomalyInDays": 60,
"newDeviceInDays": 180,
"userBasedRiskBehaviorInDays": 90
}
})
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/riskSettings');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "dataRetention": {\n "userLocationAnomalyInDays": 60,\n "newDeviceInDays": 180,\n "userBasedRiskBehaviorInDays": 90\n }\n}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"
url = URI("{{apiPath}}/environments/{{envID}}/riskSettings")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"dataRetention": {
"userLocationAnomalyInDays": 60,
"newDeviceInDays": 180,
"userBasedRiskBehaviorInDays": 90
}
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"dataRetention\": {\n \"userLocationAnomalyInDays\": 60,\n \"newDeviceInDays\": 180,\n \"userBasedRiskBehaviorInDays\": 90\n }\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/riskSettings")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "PUT"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
200 OK
{
"_links": {
"self": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/riskSettings/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"environment": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
}
},
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"dataRetention": {
"userLocationAnomalyInDays": 60,
"newDeviceInDays": 180,
"userBasedRiskBehaviorInDays": 90
},
"updatedAt": "2025-12-16T13:33:50.160Z"
}