Configures the time zone.
GET https://<IP-address-of-SPS>/api/configuration/datetime/timezone
| Cookie name | Description | Required | Values |
|---|---|---|---|
| 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 details on authentication, see Authenticate to the SPS REST API. Note that 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). |
The following command displays the configured time zone.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/datetime/timezone
The following is a sample response received when querying the configured time zone.
For details of the meta object, see Message format.
{
"body": "America/New_York",
"key": "timezone",
"meta": {
"first": "/api/configuration/datetime/ntp_servers",
"href": "/api/configuration/datetime/timezone",
"last": "/api/configuration/datetime/timezone",
"next": null,
"parent": "/api/configuration/datetime",
"previous": "/api/configuration/datetime/ntp_servers",
"transaction": "/api/transaction"
}
}
To modify time zone, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/datetime/timezone endpoint. You can find a detailed description of the available time zone values listed in Element .
For details, see Commit a transaction.
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.
| Code | Description | Notes |
|---|---|---|
| 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. |
| 401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
| 404 | NotFound | The requested object does not exist. |
Contains the configuration endpoints for managing SPS.
GET https://<IP-address-of-SPS>/api/configuration/management
| Cookie name | Description | Required | Values |
|---|---|---|---|
| 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 details on authentication, see Authenticate to the SPS REST API. Note that 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). |
The following command lists management configuration endpoints.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management
The following is a sample response received when listing management endpoints.
For details of the meta object, see Message format.
{
"items": [
{
"key": "certificates",
"meta": {
"href": "/api/configuration/management/certificates"
}
},
{
"key": "disk_fillup_prevention",
"meta": {
"href": "/api/configuration/management/disk_fillup_prevention"
}
},
{
"key": "email",
"meta": {
"href": "/api/configuration/management/email"
}
},
{
"key": "health_monitoring",
"meta": {
"href": "/api/configuration/management/health_monitoring"
}
},
{
"key": "snmp",
"meta": {
"href": "/api/configuration/management/snmp"
}
},
{
"key": "soap",
"meta": {
"href": "/api/configuration/management/soap"
}
},
{
"key": "syslog",
"meta": {
"href": "/api/configuration/management/syslog"
}
},
{
"key": "webinterface",
"meta": {
"href": "/api/configuration/management/webinterface"
}
}
],
"meta": {
"first": "/api/configuration/aaa",
"href": "/api/configuration/management",
"last": "/api/configuration/x509",
"next": "/api/configuration/network",
"parent": "/api/configuration",
"previous": "/api/configuration/local_services",
"transaction": "/api/transaction"
}
}
| Endpoints | Description |
|---|---|
| certificates | References the certificates of SPS's internal Certificate Authority, Timestamping Authority, and the SSL certificate of the web interface. |
| disk_fillup_prevention | Disk fill-up prevention. |
| SMTP server address and authentication, administrator e-mail, and e-mail addresses for alerts and reports. | |
| health_monitoring | Configuration settings for monitoring the utilization of SPS. |
| snmp | SNMP settings. |
| soap | Configuration settings for the RPC API. |
| syslog | Syslog server address and authentication. |
| webinterface | Configuration settings for the SPS web interface. |
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.
| Code | Description | Notes |
|---|---|---|
| 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. |
| 401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
| 404 | NotFound | The requested object does not exist. |
SPS can send its system log messages to remote syslog servers, for example, syslog-ng Premium Edition, syslog-ng Store Box, Splunk, or HPE ArcSight Data Platform.
GET https://<IP-address-of-SPS>/api/configuration/management/syslog
| Cookie name | Description | Required | Values |
|---|---|---|---|
| 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 details on authentication, see Authenticate to the SPS REST API. Note that 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). |
The following command lists the syslog server settings.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/management/syslog
The following is a sample response received when listing syslog server settings.
For details of the meta object, see Message format.
{
"body": {
"certificates": {
"ca": "<ca-cert>",
"client": {
"key": "191725ec-b71b-47ab-9e87-561a5d9e2bb7",
"meta": {
"href": "/api/configuration/x509/191725ec-b71b-47ab-9e87-561a5d9e2bb7"
}
}
},
"include_node_id": true,
"receivers": [
{
"address": {
"selection": "ip",
"value": "10.20.30.40"
},
"port": 514,
"protocol": {
"ip_protocol": "tcp",
"protocol_type": "legacy-bsd",
"tls_enabled": false
}
}
],
"server_key_check": "optional-trusted"
},
"key": "syslog",
"meta": {
"first": "/api/configuration/management/certificates",
"href": "/api/configuration/management/syslog",
"last": "/api/configuration/management/webinterface",
"next": "/api/configuration/management/webinterface",
"parent": "/api/configuration/management",
"previous": "/api/configuration/management/soap",
"transaction": "/api/transaction"
}
}| Element | Type | Description | ||
|---|---|---|---|---|
| key | string | Top level element, contains the ID of the endpoint. | ||
| body | Top level element (string) | Contains the syslog server configuration settings. | ||
| certificates | Top level item | Contains the certificates of the client (SPS), and the certificate of the CA. | ||
| ca | string |
The CA certificate of the Certificate Authority. Configure this option if the value of the tls_enabled element is set to true. | ||
| client | string |
Configure this option if the value of the tls_enabled element is set to true, and the syslog server requires mutual authentication. Otherwise, set its value to null. References the identifier of the client's (SPS'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). | ||
| include_node_id | boolean |
Set to true to display separate hostnames for syslog messages sent by the nodes of a SPS HA cluster. The node ID included in the hostname filed of the syslog message is the MAC address of the node's HA interface. Messages of the core firmware are always sent by the master node. | ||
| receivers | Top level list | Contains the addresses of the syslog servers. | ||
| server_key_check | string |
Configures validating the syslog server's certificate with the CA. The following values are possible:
| ||
| Elements of receivers | Type | Description | |
|---|---|---|---|
| address | Top level item | Contains the address of the syslog server. | |
| selection | string |
Defines the address type (IP or domain name). Possible values are:
| |
| value | string | The address of the syslog server, corresponding to the format set in the selection field. | |
| port | int | The port of the syslog server. | |
| protocol | Top level item | Contains the syslog protocol settings. | |
| ip_protocol | string |
Configures the IP protocol. The following options are available:
| |
| protocol_type | string |
Configures the syslog protocol. The following options are available:
| |
| tls_enabled | string |
Set to true to enable TLS encryption. If TLS is enabled, the value of the ca and client elements cannot be null. | |
Default settings: no external syslog servers.
{
"certificates": {
"ca": null,
"client": null
},
"include_node_id": true,
"receivers": [],
"server_key_check": "optional-untrusted"
}SPS uses only the key part of the CA certificate.
You can choose to upload a single certificate or a certificate chain.
To use a certificate with the SPS API, remove all data, and substitute line breaks with \n. The same is true for a certificate chain: copy individual certificates one after the other, 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"
To modify the syslog server settings, you have to:
For details, see Open a transaction.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/management/syslog endpoint. You can find a detailed description of the available parameters listed in Element.
For details, see Commit a transaction.
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.
| Code | Description | Notes |
|---|---|---|
| 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. |
| 401 | AuthenticationFailure | Authenticating the user with the given credentials has failed. |
| 404 | NotFound | The requested object does not exist. |
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center