Retrieve Details on MalOp Notification Settings
Endpoint URL: https://<your server/rest/settings/configurations
Endpoint URI: settings/configurations
Action: GET
Retrieves details on MalOp notification settings.
This API request is supported on versions 20.2.61 and higher.
Note
Ensure that you have logged into the Cybereason platform. For details, see Log in with the API.
Request Headers
You must add an Content-Type:application/json header with the request.
Note
If you are using cURL, add the authorization cookie details or the path to the file with cookie details with every request.
Request Body
None
Request Parameters
URL/URI parameters: None
Request Body Parameters: None
Response Success Schema
The response contains the following fields:
Field |
Type |
Description |
---|---|---|
outcome |
String |
The result of the retrieval operation. |
data |
Array |
An object containing the details of all settings. |
type |
Enum |
The type of setting about which you are retrieving information. For this response, the value of this field is PropertyConfiguration. |
name |
String |
The specific setting about which you are retrieving details. |
value |
Array |
The details on the settings. The fields inside this object differ per setting. |
lastUpdate |
Integer |
The last time the setting was updated. |
Response Failure Schema
None
Example: Retrieve setting details
Request
curl --request GET \ --url https://12.34.56.78/rest/settings/configuration \ --header 'Content-Type:text/plain' \
Response
{
"outcome": "success",
"data": [
{
"type": "PropertyConfiguration",
"name": "scribe.archive.sensors.data.migration",
"value": {
"type": "ScribeArchiveSensorsMigrationConfig",
"archiveDataMigrate": false
},
"lastUpdate": 1602525876869
},
{
"type": "PropertyConfiguration",
"name": "password.policy",
"value": {
"type": "PasswordPolicy",
"passwordComplexity": "Basic",
"passwordExpiration": 6,
"lockoutPolicyEnabled": false,
"failedLoginAttempts": 3,
"failedLoginAttemptInterval": 3,
"failedLoginLockReset": 60
},
"lastUpdate": 1602525305283
},
{
"type": "PropertyConfiguration",
"name": "custom.smtp",
"value": {
"type": "CustomSmtpServerConfig",
"securityProtocol": "TLS",
"host": null,
"port": 0,
"username": null,
"password": null,
"enabled": false
},
"lastUpdate": 1602525305283
},
{
"type": "PropertyConfiguration",
"name": "malop.notifications",
"value": {
"type": "malopNotificationConfig",
"enabled": true,
"frequency": "IMMEDIATE",
"trigger": "CREATION",
"malopTypes": []
},
"lastUpdate": 1603013427752
},
{
"type": "PropertyConfiguration",
"name": "sensor.statuses.policy",
"value": {
"type": "SensorStatusesPolicyConfig",
"offlineToStaleInDays": 30,
"staleNotificationsEnabled": true,
"autoArchivingEnabled": true,
"staleToArchivedInDays": 60,
"autoArchivedNotificationsEnabled": true,
"staleNotificationsFrequency": "WEEKLY"
},
"lastUpdate": 1602525305245
},
{
"type": "PropertyConfiguration",
"name": "login.enable.2fa",
"value": {
"type": "FeatureConfiguration",
"enabled": false
},
"lastUpdate": 1602525305289
},
{
"type": "PropertyConfiguration",
"name": "duplicate.sensors.policy",
"value": {
"type": "FeatureConfiguration",
"enabled": true
},
"lastUpdate": 1602525738912
}
]
}
Request
Response
{
"outcome": "success",
"data": [
{
"type": "PropertyConfiguration",
"name": "scribe.archive.sensors.data.migration",
"value": {
"type": "ScribeArchiveSensorsMigrationConfig",
"archiveDataMigrate": false
},
"lastUpdate": 1602525876869
},
{
"type": "PropertyConfiguration",
"name": "password.policy",
"value": {
"type": "PasswordPolicy",
"passwordComplexity": "Basic",
"passwordExpiration": 6,
"lockoutPolicyEnabled": false,
"failedLoginAttempts": 3,
"failedLoginAttemptInterval": 3,
"failedLoginLockReset": 60
},
"lastUpdate": 1602525305283
},
{
"type": "PropertyConfiguration",
"name": "custom.smtp",
"value": {
"type": "CustomSmtpServerConfig",
"securityProtocol": "TLS",
"host": null,
"port": 0,
"username": null,
"password": null,
"enabled": false
},
"lastUpdate": 1602525305283
},
{
"type": "PropertyConfiguration",
"name": "malop.notifications",
"value": {
"type": "malopNotificationConfig",
"enabled": true,
"frequency": "IMMEDIATE",
"trigger": "CREATION",
"malopTypes": []
},
"lastUpdate": 1603013427752
},
{
"type": "PropertyConfiguration",
"name": "sensor.statuses.policy",
"value": {
"type": "SensorStatusesPolicyConfig",
"offlineToStaleInDays": 30,
"staleNotificationsEnabled": true,
"autoArchivingEnabled": true,
"staleToArchivedInDays": 60,
"autoArchivedNotificationsEnabled": true,
"staleNotificationsFrequency": "WEEKLY"
},
"lastUpdate": 1602525305245
},
{
"type": "PropertyConfiguration",
"name": "login.enable.2fa",
"value": {
"type": "FeatureConfiguration",
"enabled": false
},
"lastUpdate": 1602525305289
},
{
"type": "PropertyConfiguration",
"name": "duplicate.sensors.policy",
"value": {
"type": "FeatureConfiguration",
"enabled": true
},
"lastUpdate": 1602525738912
}
]
}
Request
Depending on your browser settings, this linked file may open in a separate tab instead of downloading directly to your machine. If this happens, use the Save As option in your browser to save the file locally.
import requests
import json
# Login information
username = "[email protected]"
password = "mypassword"
server = "yourserver.com"
port = "443"
data = {
"username": username,
"password": password
}
headers = {"Content-Type": "application/json"}
base_url = "https://" + server + ":" + port
login_url = base_url + "/login.html"
session = requests.session()
login_response = session.post(login_url, data=data, verify=True)
print (login_response.status_code)
print (session.cookies.items())
# Request URL
endpoint_url = "/rest/settings/configuration"
api_url = base_url + endpoint_url
api_response = session.request("GET", api_url, headers=headers)
your_response = json.loads(api_response.content)
print(json.dumps(your_response, indent=4, sort_keys=True))
Response
{
"outcome": "success",
"data": [
{
"type": "PropertyConfiguration",
"name": "scribe.archive.sensors.data.migration",
"value": {
"type": "ScribeArchiveSensorsMigrationConfig",
"archiveDataMigrate": false
},
"lastUpdate": 1602525876869
},
{
"type": "PropertyConfiguration",
"name": "password.policy",
"value": {
"type": "PasswordPolicy",
"passwordComplexity": "Basic",
"passwordExpiration": 6,
"lockoutPolicyEnabled": false,
"failedLoginAttempts": 3,
"failedLoginAttemptInterval": 3,
"failedLoginLockReset": 60
},
"lastUpdate": 1602525305283
},
{
"type": "PropertyConfiguration",
"name": "custom.smtp",
"value": {
"type": "CustomSmtpServerConfig",
"securityProtocol": "TLS",
"host": null,
"port": 0,
"username": null,
"password": null,
"enabled": false
},
"lastUpdate": 1602525305283
},
{
"type": "PropertyConfiguration",
"name": "malop.notifications",
"value": {
"type": "malopNotificationConfig",
"enabled": true,
"frequency": "IMMEDIATE",
"trigger": "CREATION",
"malopTypes": []
},
"lastUpdate": 1603013427752
},
{
"type": "PropertyConfiguration",
"name": "sensor.statuses.policy",
"value": {
"type": "SensorStatusesPolicyConfig",
"offlineToStaleInDays": 30,
"staleNotificationsEnabled": true,
"autoArchivingEnabled": true,
"staleToArchivedInDays": 60,
"autoArchivedNotificationsEnabled": true,
"staleNotificationsFrequency": "WEEKLY"
},
"lastUpdate": 1602525305245
},
{
"type": "PropertyConfiguration",
"name": "login.enable.2fa",
"value": {
"type": "FeatureConfiguration",
"enabled": false
},
"lastUpdate": 1602525305289
},
{
"type": "PropertyConfiguration",
"name": "duplicate.sensors.policy",
"value": {
"type": "FeatureConfiguration",
"enabled": true
},
"lastUpdate": 1602525738912
}
]
}