system endpoints

Edit online

Use the references for REST API 20.0 system endpoints.

GET /system/about
Retrieves the current system information
GET /system/authorization/password_policies
Retrieves a list of Password Policies that exist on the system
GET /system/authorization/password_policies/{id}
Retrieves a single Password Policies that exist on the system
POST /system/authorization/password_policies/{id}
Update a single Password Policies available on the system. This policy defines the requirements for passwords that are stored locally, and that will be enforced on login or while creating a new user, or while a user is updating their password.
POST /system/authorization/password_validators
Creates a new password validator for the provided password based on the current Password Policy.
GET /system/authorization/settings
Retrieves the current Authentication Settings.
POST /system/authorization/settings
Updates the Authentication Settings.
GET /system/email_servers
Retrieves a list of all email servers.
POST /system/email_servers
Creates a new email server.
DELETE /system/email_servers/{email_server_id}
Deletes an email server.
GET /system/email_servers/{email_server_id}
Retrieves an email server based on the supplied email server ID.
POST /system/email_servers/{email_server_id}
Updates an existing email server.
GET /system/eula_acceptances
Retrieves the list of EULA acceptance statuses that the caller has permission to see.
GET /system/eula_acceptances/{id}
Retrieves an individual EULA Acceptance by id.
POST /system/eula_acceptances/{id}
Updates an individual EULA acceptance.
GET /system/eulas
Retrieves a list of EULAs.
GET /system/information/encodings
Retrieves the list of encodings that are supported by the system for event data..
GET /system/information/locales
Retrieve Locales.
POST /system/server_connection_validator
Creates a server connection validator for the provided hostname and port, based on the provided host ids.
GET /system/servers
Retrieves a list of all server hosts in the deployment.
GET /system/servers/{server_id}
Retrieves a server host based on the supplied server ID.
POST /system/servers/{server_id}
Updates an existing server.
GET /system/servers/{server_id}/firewall_rules
Retrieves a list of access control firewall rules based on the supplied server ID.
PUT /system/servers/{server_id}/firewall_rules
Sets the access control firewall rules based on the supplied server ID.
GET /system/servers/{server_id}/network_interfaces/bonded
Retrieves a list of the bonded network interfaces based on the supplied server ID.
POST /system/servers/{server_id}/network_interfaces/bonded
Creates a new bonded network interface.
DELETE /system/servers/{server_id}/network_interfaces/bonded/{device_name}
Removes a bonded network interface.
POST /system/servers/{server_id}/network_interfaces/bonded/{device_name}
Updates an existing bonded network interface.
GET /system/servers/{server_id}/network_interfaces/ethernet
Retrieves a list of the ethernet network interfaces based on the supplied server ID.
POST /system/servers/{server_id}/network_interfaces/ethernet/{device_name}
Updates an ethernet network interface based on the suppied server_Id and device_name.
GET /system/servers/{server_id}/system_time_settings
Retrieves the system time and time zone settings of a server host based on the supplied server ID.
POST /system/servers/{server_id}/system_time_settings
Sets the system time and time zone settings of to a server host. Services are restarted after the call and service interruptions will occur.
GET /system/servers/{server_id}/timezones
Retrieves all the available time zones that can be set for a server.