system endpoints

Edit online

Use the references for REST API 21.0 system endpoints.

GET /system/about DEPRECATED
Retrieves the current system information
GET /system/authorization/password_policies DEPRECATED
Retrieves a list of Password Policies that exist on the system
GET /system/authorization/password_policies/{id} DEPRECATED
Retrieves a single Password Policies that exist on the system
POST /system/authorization/password_policies/{id} DEPRECATED
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 DEPRECATED
Creates a new password validator for the provided password based on the current Password Policy.
GET /system/authorization/settings DEPRECATED
Gets the Authentication Settings for the system. These settings apply to all methods of authentication with the following exceptions.
POST /system/authorization/settings DEPRECATED
Updates the Authentication Settings. Changes to these values take effect immediately, but are not retroactive. For example, a change to the inactivity_timeout setting will not change the inactivity timeout for currently logged in users. When setting the account_lockout and host_lockout fields simultaneously, consider how they will operate. e.g. if the account based lockout configuration is less restrictive than the host based lockout configuration, a single host will be able to attempt to log in with multiple accounts before the IP address of the caller is locked out. Also, if users of the system are behind a proxy, consider disabling the host based lockout and enabling the account based lockout.
GET /system/email_servers DEPRECATED
Retrieves a list of all email servers.
POST /system/email_servers DEPRECATED
Creates a new email server.
DELETE /system/email_servers/{email_server_id} DEPRECATED
Deletes an email server.
GET /system/email_servers/{email_server_id} DEPRECATED
Retrieves an email server based on the supplied email server ID.
POST /system/email_servers/{email_server_id} DEPRECATED
Updates an existing email server.
GET /system/eula_acceptances DEPRECATED
Retrieves the list of EULA acceptance statuses that the caller has permission to see.
GET /system/eula_acceptances/{id} DEPRECATED
Retrieves an individual EULA Acceptance by id.
POST /system/eula_acceptances/{id} DEPRECATED
Updates an individual EULA acceptance.
GET /system/eulas DEPRECATED
Retrieves a list of EULAs.
GET /system/information/encodings DEPRECATED
Retrieves the list of encodings that are supported by the system for event data..
GET /system/information/locales DEPRECATED
Retrieve Locales.
POST /system/server_connection_validator DEPRECATED
Creates a server connection validator for the provided hostname and port, based on the provided host ids.
GET /system/servers DEPRECATED
Retrieves a list of all server hosts in the deployment.
GET /system/servers/{server_id} DEPRECATED
Retrieves a server host based on the supplied server ID.
POST /system/servers/{server_id} DEPRECATED
Updates an existing server.
GET /system/servers/{server_id}/firewall_rules DEPRECATED
Retrieves a list of access control firewall rules based on the supplied server ID.
PUT /system/servers/{server_id}/firewall_rules DEPRECATED
Sets the access control firewall rules based on the supplied server ID.
GET /system/servers/{server_id}/network_interfaces/bonded DEPRECATED
Retrieves a list of the bonded network interfaces based on the supplied server ID.
POST /system/servers/{server_id}/network_interfaces/bonded DEPRECATED
Creates a new bonded network interface.
DELETE /system/servers/{server_id}/network_interfaces/bonded/{device_name} DEPRECATED
Removes a bonded network interface.
POST /system/servers/{server_id}/network_interfaces/bonded/{device_name} DEPRECATED
Updates an existing bonded network interface.
GET /system/servers/{server_id}/network_interfaces/ethernet DEPRECATED
Retrieves a list of the ethernet network interfaces based on the supplied server ID.
POST /system/servers/{server_id}/network_interfaces/ethernet/{device_name} DEPRECATED
Updates an ethernet network interface based on the suppied server_Id and device_name.
GET /system/servers/{server_id}/system_time_settings DEPRECATED
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 DEPRECATED
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 DEPRECATED
Retrieves all the available time zones that can be set for a server.