Disk fill-up prevention
Contains the configuration options for preventing disk fill-up.
URL
GET https://<IP-address-of-SPS>/api/configuration/management/disk_fillup_prevention
Cookies
session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists disk fill-up prevention options.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/disk_fillup_prevention
Response
The following is a sample response received when listing disk fill-up prevention settings.
For more information on the meta object, see Message format.
{
"body": {
"archiving_enabled": false,
"enabled": true,
"used_space_ratio_limit": 80
},
"key": "disk_fillup_prevention",
"meta": {
"first": "/api/configuration/management/certificates",
"href": "/api/configuration/management/disk_fillup_prevention",
"last": "/api/configuration/management/webinterface",
"next": "/api/configuration/management/email",
"parent": "/api/configuration/management",
"previous": "/api/configuration/management/certificates",
"transaction": "/api/transaction"
}
}
key |
|
string |
Top level element, contains the ID of the endpoint. |
body |
|
Top level element (string) |
Contains the configuration settings for disk fill-up prevention. |
|
archiving_enabled |
boolean |
Set to true to automatically start all configured archiving/cleanup jobs when disk usage goes over the value of the used_space_ratio_limit element. |
|
enabled |
boolean |
Set to true to enable disk fill-up prevention. |
|
used_space_ratio_limit |
int |
Disk utilization limit, in percent. When used disk space reaches this limit, SPS disconnects all clients.
Set to 0 to turn the feature off. |
Modify disk fill-up prevention settings
To modify the disk fill-up prevention settings, you have to:
-
Open a transaction
For more information, see Open a transaction.
-
Modify the JSON object of the disk fill-up configuration endpoint.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/management/disk_fillup_prevention endpoint. You can find a detailed description of the available parameters listed in Element .
-
Commit your changes
For more information, see Commit a transaction.
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
201 |
Created |
The new resource was successfully created. |
401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
404 |
NotFound |
The requested object does not exist. |
Mail settings
Configuration settings for SMTP server address and authentication, administrator e-mail, and e-mail addresses for alerts and reports.
URL
GET https://<IP-address-of-SPS>/api/configuration/management/email
Cookies
session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists mail settings:
Querying email configuration request
For more information on the meta object, see Message format.
Response
The following is a sample response received when listing mail settings:
Querying email configuration response
key |
|
|
string |
Top level element, contains the ID of the endpoint. |
body |
|
|
Top level element (string) |
Contains the configuration options for e-mail. |
|
admin_address |
|
string |
The e-mail address of the administrator of SPS. |
|
alerting_address |
|
string |
The e-mail address where monitoring alerts are sent. |
|
reporting_address |
|
string |
The e-mail address where traffic reports are sent. |
|
sender_address |
|
string |
The address of the sender (SPS). |
|
smtp_auth |
|
Top level item |
Configures authentication to the SMTP server. |
|
|
enabled |
boolean |
Set to true to enable authenticating to the SMTP server. |
|
|
password |
string |
References the password of the authenticating user. You configure passwords at the /api/configuration/passwords/ endpoint.
To modify or add a password, use the value of the returned key as the value of the password element, and remove any child elements (including the key). |
|
|
username |
string |
The username for authenticating to the SMTP server. |
|
smtp_encryption |
|
Top level item |
Configuration settings for encrypting the communication between SPS and the SMTP server. |
|
smtp_server |
|
Top level item |
Contains the address of the SMTP server. |
|
|
selection |
string |
Defines the address type (IP or domain name). Possible values are:
|
|
|
value |
string |
The address of the SMTP server. |
client_authentication |
|
Top level item |
Configures authenticating as a client with an X.509 certificate.
Can only be enabled if the value of the selection element is set to starttls. |
|
enabled |
boolean |
Set to true to enable authenticating as a client with an X.509 certificate.
Can only be enabled if the value of the selection element of snmp_encryption is set to starttls. |
|
x509_identity |
|
References the identifier of the authenticating client's X.509 certificate. You can configure certificates at the /api/configuration/x509/ endpoint.
To modify or add an X.509 certificate, use the value of the returned key as the value of the x509_identity element, and remove any child elements (including the key). For details, see Certificates stored on SPS. |
selection |
|
string |
Configures encrypted communication with the SMTP server. The following values are possible:
|
server_certificate_check |
|
Top level item |
Configuration settings for validating the SMTP server's certificate.
Can only be enabled if the value of the selection element is set to starttls. |
|
enabled |
boolean |
Set to true to enable validating the SMTP server's certificate.
Can only be enabled if the value of the selection element of snmp_encryption is set to starttls. |
|
server_certificate_ca |
string |
The CA certificate of the Certificate Authority. |
Examples:
Enable authentication to the SMTP server:
Configure authentication to the SMTP server request
Configure STARTTLS encryption without certificate checks:
Configure STARTTLS encryption without certificate checks request
Configure STARTTLS encryption with server certificate check, and authenticate as client with an X.509 certificate:
Configure STARTTLS encryption with server certificate check, and authenticate as client with an X.509 certificate request
CA certificates
CA certificates must not contain any metadata. SPS uses only the key part of the certificate.
To use a certificate with the SPS API, remove all metadata, and substitute line breaks with \n.
The following is an example certificate, as used on the SPS web interface:
-----BEGIN CERTIFICATE-----
MIIDnDCCAoQCCQDc536Ob5tPQTANBgkqhkiG9w0BAQUFADCBjzELMAkGA1UEBhMC
Q0ExEDAOBgNVBAgTB09udGFyaW8xEDAOBgNVBAcTB1Rvcm9udG8xEDAOBgNVBAoT
B0JhbGFiaXQxFjAUBgNVBAsTDURvY3VtZW50YXRpb24xEDAOBgNVBAMTB2JhbGFi
aXQxIDAeBgkqhkiG9w0BCQEWEWNhdGFpbEBiYWxhYml0Lmh1MB4XDTE2MDQyMjE2
MDAyNloXDTE3MDQyMjE2MDAyNlowgY8xCzAJBgNVBAYTAkNBMRAwDgYDVQQIEwdP
bnRhcmlvMRAwDgYDVQQHEwdUb3JvbnRvMRAwDgYDVQQKEwdCYWxhYml0MRYwFAYD
VQQLEw1Eb2N1bWVudGF0aW9uMRAwDgYDVQQDEwdiYWxhYml0MSAwHgYJKoZIhvcN
AQkBFhFjYXRhaWxAYmFsYWJpdC5odTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC
AQoCggEBAOGa9I2jmVlVdVWEI/Wy7ahTeyaIjK52FQUXqxG8okOSD+nV74ZFUuiS
59X+2Ow1aDqVGrDMgPNhSVpYXUvDUAUOILJW4rAIoxDY6vDU9/4v9dDiQfEPlauw
0qNRjPS1MLzjSOQDSKqPkdivkS6HKZeX3+TFq3OxO+vIrF9zFfp9T+eDG2oSobPc
3mV2zkvtD61CXzbezAVdArDl6WnysRyzxyH8WEhFwZepWxFD9Y5N1dzKody7Hncs
X5kVIv0+Z6bBHfg/7wHWysJdwNuLr0ByTOvPM6WdA83k3Fy2gYNk7Rc0BbRFbQTX
hJVfUzSUWHVhFQtAb4diKU5voqepfNMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEA
R5DIwOHsEKoGkiI3cHC2VMnxP2rRhpTneh6El+DFnQPdjrXa+tnqV4TdnNaD+FvP
AB1kqbmC4hJAsjMLU2b1ne6m+SLmzhRuMxcA6x+fnYvcQT57IbRdq2E/4oJGeyuy
0jQE+nmoVD3lDytIOxCfQvZhl1tcbBE5hp5USme4PmNhY6QfUlgjsFjPfoVG7XDB
uNaUoWS6RvZPmL5IuvF9tqe96ES6DTjC8rBfQYvSoVNjjPnUMx0C8xstRSEG7oJc
N5+4ImYnFNxSG20hZpFy0OFDf2g7Fx+W50/NtXamUF1Sf8WlPZc03oVl1/Fzo7mt
qYyyD1ld89OUEYZ+aJQd/A==
-----END CERTIFICATE-----
The same certificate, as accepted by the SPS API:
"certificate": "-----BEGIN CERTIFICATE-----\nMIIDnDCCAoQCCQDc536Ob5tPQTANBgkqhkiG9w0BAQUFADCBjzELMAkGA1UEBhMC\nQ0ExEDAOBgNVBAgTB09udGFyaW8xEDAOBgNVBAcTB1Rvcm9udG8xEDAOBgNVBAoT\nB0JhbGFiaXQxFjAUBgNVBAsTDURvY3VtZW50YXRpb24xEDAOBgNVBAMTB2JhbGFi\naXQxIDAeBgkqhkiG9w0BCQEWEWNhdGFpbEBiYWxhYml0Lmh1MB4XDTE2MDQyMjE2\nMDAyNloXDTE3MDQyMjE2MDAyNlowgY8xCzAJBgNVBAYTAkNBMRAwDgYDVQQIEwdP\nbnRhcmlvMRAwDgYDVQQHEwdUb3JvbnRvMRAwDgYDVQQKEwdCYWxhYml0MRYwFAYD\nVQQLEw1Eb2N1bWVudGF0aW9uMRAwDgYDVQQDEwdiYWxhYml0MSAwHgYJKoZIhvcN\nAQkBFhFjYXRhaWxAYmFsYWJpdC5odTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC\nAQoCggEBAOGa9I2jmVlVdVWEI/Wy7ahTeyaIjK52FQUXqxG8okOSD+nV74ZFUuiS\n59X+2Ow1aDqVGrDMgPNhSVpYXUvDUAUOILJW4rAIoxDY6vDU9/4v9dDiQfEPlauw\n0qNRjPS1MLzjSOQDSKqPkdivkS6HKZeX3+TFq3OxO+vIrF9zFfp9T+eDG2oSobPc\n3mV2zkvtD61CXzbezAVdArDl6WnysRyzxyH8WEhFwZepWxFD9Y5N1dzKody7Hncs\nX5kVIv0+Z6bBHfg/7wHWysJdwNuLr0ByTOvPM6WdA83k3Fy2gYNk7Rc0BbRFbQTX\nhJVfUzSUWHVhFQtAb4diKU5voqepfNMCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEA\nR5DIwOHsEKoGkiI3cHC2VMnxP2rRhpTneh6El+DFnQPdjrXa+tnqV4TdnNaD+FvP\nAB1kqbmC4hJAsjMLU2b1ne6m+SLmzhRuMxcA6x+fnYvcQT57IbRdq2E/4oJGeyuy\n0jQE+nmoVD3lDytIOxCfQvZhl1tcbBE5hp5USme4PmNhY6QfUlgjsFjPfoVG7XDB\nuNaUoWS6RvZPmL5IuvF9tqe96ES6DTjC8rBfQYvSoVNjjPnUMx0C8xstRSEG7oJc\nN5+4ImYnFNxSG20hZpFy0OFDf2g7Fx+W50/NtXamUF1Sf8WlPZc03oVl1/Fzo7mt\nqYyyD1ld89OUEYZ+aJQd/A==\n-----END CERTIFICATE-----\n"
Modify mail settings
To modify mail settings, you have to:
-
Open a transaction
For more information, see Open a transaction.
-
Modify the JSON object of the endpoint.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/management/email endpoint. You can find a detailed description of the available parameters listed in Element .
-
Commit your changes
For more information, see Commit a transaction.
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
201 |
Created |
The new resource was successfully created. |
401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
404 |
NotFound |
The requested object does not exist. |
Health monitoring
Configuration settings for monitoring the utilization of SPS.
URL
GET https://<IP-address-of-SPS>/api/configuration/management/health_monitoring
Cookies
session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists health monitoring settings.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/health_monitoring
Response
The following is a sample response received when listing health monitoring settings.
For more information on the meta object, see Message format.
{
"body": {
"maximum_disk_utilization_ratio": 80,
"maximum_load1": null,
"maximum_load15": null,
"maximum_load5": null,
"maximum_swap_utilization_ratio": 70
},
"key": "health_monitoring",
"meta": {
"first": "/api/configuration/management/certificates",
"href": "/api/configuration/management/health_monitoring",
"last": "/api/configuration/management/webinterface",
"next": "/api/configuration/management/snmp",
"parent": "/api/configuration/management",
"previous": "/api/configuration/management/email",
"transaction": "/api/transaction"
}
}
key |
|
string |
Top level element, contains the ID of the endpoint. |
body |
|
Top level element (string) |
Contains health monitoring settings. |
|
maximum_disk_utilization_ratio |
int |
The highest allowed value for disk utilization (in %). |
|
maximum_load1 |
int |
Average maximum for load for 1 minute. |
|
maximum_load15 |
int |
Average maximum load for 15 minutes. |
|
maximum_load5 |
int |
Average maximum load for 5 minutes. |
|
maximum_swap_utilization_ratio |
int |
The highest allowed value for swap utilization (in %). |
Modify health monitoring settings
To modify health monitoring settings, you have to:
-
Open a transaction
For more information, see Open a transaction.
-
Modify the JSON object of the endpoint.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/management/health_monitoring endpoint.You can find a detailed description of the available parameters listed in Element .
-
Commit your changes
For more information, see Commit a transaction.
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
201 |
Created |
The new resource was successfully created. |
401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
404 |
NotFound |
The requested object does not exist. |
SNMP settings
Contains the configuration endpoints for SNMP settings.
URL
GET https://<IP-address-of-SPS>/api/configuration/management/snmp
Cookies
session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists the endpoints for SNMP configuration settings.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/snmp
Response
The following is a sample response received when listing SNMP configuration endpoints.
For more information on the meta object, see Message format.
{
"items": [
{
"key": "trap",
"meta": {
"href": "/api/configuration/management/snmp/trap"
}
}
],
"meta": {
"first": "/api/configuration/management/certificates",
"href": "/api/configuration/management/snmp",
"last": "/api/configuration/management/webinterface",
"next": "/api/configuration/management/splunk_forwarder",
"parent": "/api/configuration/management",
"previous": "/api/configuration/management/health_monitoring",
"transaction": "/api/transaction"
}
}
trap |
Configuration settings for SNMP traps. |
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
404 |
NotFound |
The requested object does not exist. |