System Endpoints
Use the references for REST API V9.0 system endpoints.
GET /system/authorization/password_policies
View a list of all the Password Policies available on the system. Currently this is limited to exactly 1 policy. A 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.
Table 1: GET /system/authorization/password_policies Resource Details
MIME Type |
|---|
application/json |
Table 2: GET /system/authorization/password_policies Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
Table 3: GET /system/authorization/password_policies Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The Password Policy list was retrieved |
Response Description
An array of Password Policy objects. Passwords stored in the system must adhere to the policy. A Password Policy object has the following fields:
id - Number - The ID of the Password Policy
minimum_length - The minimum length that passwords on the system must adhere to
variance_rules - Contains a subset of the following values: UPPER_CASE, LOWER_CASE, NUMBER, OTHER.
variance_rules_required_count - The number of variance_rules that must be met before a password is said to 'pass'. This must be a number between 0 and 4.
password_history_size - The number of password_expiry_intervals that passwords are remembered and not allowed to be reused. Must be greater than 0, or 'null'. For example, with a password_history_size of 3 and a password_expiry_interval of 90 (days), 270 days must pass before a password can be reused. If a user changes their password four times in one day, they still cannot use the first password because 270 days have not passed.
password_expiry_interval - The number of milliseconds before a password must be changed. Setting this field to 'null' means passwords never expire.
disallow_repeating_characters - Set this value to true to disallow more than 2 repeating characters. For example, "abbc" is allowed, where "abbbc" is not.
Response Sample
[ { "disallow_repeating_characters": true, "id": 42, "minimum_length": 42, "password_expiry_interval": 42, "password_history_size": 42, "variance_rules": [ "String <one of: UPPER_CASE, LOWER_CASE, NUMBER, OTHER>" ], "variance_rules_required_count": 42 } ]
GET /system/authorization/password_policies/{id}
View a single Password Policies available on the system. A 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.
Table 4: GET /system/authorization/password_policies/{id} Resource Details
MIME Type |
|---|
application/json |
Table 5: GET /system/authorization/password_policies/{id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
id | path | Required | Number (Integer) | text/plain | Required. The ID of the Password Policy to retrieve. This can only be 1 |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 6: GET /system/authorization/password_policies/{id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The Password Policy was retrieved | |
404 | 1002 | When the ID parameter is not 1 |
Response Description
A single Password Policy object has the following fields:
id - Number - The ID of the Password Policy
minimum_length - The minimum length that passwords on the system must adhere to
variance_rules - Contains a subset of the following values: UPPER_CASE, LOWER_CASE, NUMBER, OTHER.
variance_rules_required_count - The number of variance_rules that must be met before a password is said to 'pass'. This must be a number between 0 and 4.
password_history_size - The number of password_expiry_intervals that passwords are remembered and not allowed to be reused. Must be greater than 0, or 'null'. For example, with a password_history_size of 3 and a password_expiry_interval of 90 (days), 270 days must pass before a password can be reused. If a user changes their password four times in one day, they still cannot use the first password because 270 days have not passed.
password_expiry_interval - The number of milliseconds before a password must be changed. Setting this field to 'null' means passwords never expire.
disallow_repeating_characters - Set this value to true to disallow more than 2 repeating characters. For example, "abbc" is allowed, where "abbbc" is not.
Response Sample
{ "disallow_repeating_characters": true, "id": 42, "minimum_length": 42, "password_expiry_interval": 42, "password_history_size": 42, "variance_rules": [ "String <one of: UPPER_CASE, LOWER_CASE, NUMBER, OTHER>" ], "variance_rules_required_count": 42 }
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.
Table 7: POST /system/authorization/password_policies/{id} Resource Details
MIME Type |
|---|
application/json |
Table 8: POST /system/authorization/password_policies/{id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
id | path | Required | Number (Integer) | text/plain | Required. The ID of the Password Policy to retrieve. This can only be 1 |
fields | header | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 9: POST /system/authorization/password_policies/{id} Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
policy | Object | application/json | Required. A single Password Policy object has the following modifiable fields:
Any other set fields will be ignored. | { "disallow_repeating_characters": true, "minimum_length": 42, "password_expiry_interval": 42, "password_history_size": 42, "variance_rules": [ "String <one of: UPPER_CASE, LOWER_CASE, NUMBER, OTHER>" ], "variance_rules_required_count": 42 } |
Table 10: POST /system/authorization/password_policies/{id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The Password Policy was updated | |
404 | 1002 | When the ID parameter was not 1 |
422 | 1010 | When the minimum_length parameter is not in the range of 1-255 |
422 | 1011 | When the variance_rules_required_count parameter is not either 0 or 3 |
422 | 1012 | When the password_history_size and the password_expiry_interval are not set correctly. Either both must be set, or both must be set to null |
422 | 1013 | When the variance_rules_required_count is greater than the number of variance_rules |
422 | 1014 | When the truncated value password_expiry_interval is 0 |
Response Description
The resulting Password Policy with the following fields:
id - Number - The ID of the Password Policy
minimum_length - The minimum length that passwords on the system must adhere to
variance_rules - Contains a subset of the following values: UPPER_CASE, LOWER_CASE, NUMBER, OTHER.
variance_rules_required_count - The number of variance_rules that must be met before a password is said to 'pass'. This must be a number between 0 and 4.
password_history_size - The number of password_expiry_intervals that passwords are remembered and not allowed to be reused. Must be greater than 0, or 'null'. For example, with a password_history_size of 3 and a password_expiry_interval of 90 (days), 270 days must pass before a password can be reused. If a user changes their password four times in one day, they still cannot use the first password because 270 days have not passed.
password_expiry_interval - The number of milliseconds before a password must be changed. Setting this field to 'null' means passwords never expire. The password_expiry_interval field will be truncated to milliseconds in a day.
disallow_repeating_characters - Set this value to true to disallow more than 2 repeating characters. For example, "abbc" is allowed, where "abbbc" is not.
Response Sample
{ "disallow_repeating_characters": true, "id": 42, "minimum_length": 42, "password_expiry_interval": 42, "password_history_size": 42, "variance_rules": [ "String <one of: UPPER_CASE, LOWER_CASE, NUMBER, OTHER>" ], "variance_rules_required_count": 42 }
POST /system/authorization/password_validators
Creates a new user password validator. Password validators are used to determine if a password passes the password policy and if it does not pass the policy it gives feedback on why the password did not pass the policy. The validator is is returned in the response from the server. The validator or the password is not persisted.
Table 11: POST /system/authorization/password_validators Resource Details
MIME Type |
|---|
application/json |
Table 12: POST /system/authorization/password_validators Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields | header | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 13: POST /system/authorization/password_validators Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
password | String | text/plain | The password that the validator will validate. | String |
Table 14: POST /system/authorization/password_validators Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | response with the password validator. The successful 200 response is returned regardless if the password passed the validation or not. The 200 response indicates the validation was performed. Details of the validation will be in the returned password validator structure. | |
404 | 38312001 | When the password field is null |
Response Description
A Password Validator with the following fields:
password - Caller is required to set this field when creating a new user password validator. This field is always null in every server response.
minimum_length_rule_passed - Indicates if the provided password passed the minimum length rule from the password policy. Set to null if the minimum length rule from the password policy is not enabled.
provided_password_length - The number of unicode characters in the provided password.
variance_rules_required_count_passed - Indicates if the provided password passed the variance count rule from the password policy. Set to null if the variance count rule is not enabled.
variance_rules_passed - Lists the variance rules that the provided password passed. Set to null if the variance count rule is not enabled.
variance_rules_failed - Lists the variance rules that the provided password failed. Set to null if the variance count rule is not enabled.
password_history_size_rule_passed - Indicates if the provided password passed the password history rule. Set to null if the password history rule is not enabled.
disallow_repeating_characters_rule_passed - Indicates if the provided password passed the repeating characters rule. Set to null if the repeating characters rule is not enabled.
Response Sample
{ "disallow_repeating_characters_rule_passed": true, "minimum_length_rule_passed": true, "password": "String", "password_history_size_rule_passed": true, "provided_password_length": 42, "variance_rules_failed": [ "String <one of: UPPER_CASE, LOWER_CASE, NUMBER, OTHER>" ], "variance_rules_passed": [ "String <one of: UPPER_CASE, LOWER_CASE, NUMBER, OTHER>" ], "variance_rules_required_count_passed": true }
GET /system/information/encodings
Retrieves the list of encodings.
Table 15: GET /system/information/encodings Resource Details
MIME Type |
|---|
application/json |
Table 16: GET /system/information/encodings Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
Table 17: GET /system/information/encodings Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The encodings were retrieved successfully. | |
500 | 1020 | An error occurred during the attempt to retrieve the encodings. |
Response Description
The list of encodings available on the system. A encoding contains the following fields:
id - String - The name/descriptor for the character encoding. Not localized.
Response Sample
[ { "id": "String" } ]
GET /system/information/locales
Retrieves a list of locales from the system, with the option to include samples.
Table 18: GET /system/information/locales Resource Details
MIME Type |
|---|
application/json |
Table 19: GET /system/information/locales Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
sample_type | query | Optional | String | text/plain | Optional - type of samples for the locale. Currently the only supported option is NUMBER. |
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 20: GET /system/information/locales Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The requested list of locales was retrieved. | |
500 | 1020 | An error occurred during the attempt to retrieve the list of locales. |
Response Description
A list of locales. A locale contains the following fields:
id - String - The tag of the locale.
label - String - The name of the locale.
sample - String - The optional sample for the locale.
Response Sample
[ { "id": "sq", "label": "Albanian", "sample": "1 234 567,89" }, { "id": "sq-AL", "label": "Albanian (Albania)", "sample": "1 234 567,89" }, { "id": "ar", "label": "Arabic", "sample": "١٬٢٣٤٬٥٦٧٫Ù̈Ù©" }, { "id": "ar-DZ", "label": "Arabic (Algeria)", "sample": "1.234.567,89" }, { "id": "ar-BH", "label": "Arabic (Bahrain)", "sample": "١٬٢٣٤٬٥٦٧٫Ù̈Ù©" } ]
GET /system/servers
Retrieve a list of all server hosts in the deployment.
Table 21: GET /system/servers Resource Details
MIME Type |
|---|
application/json |
Table 22: GET /system/servers Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 23: GET /system/servers Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The requested list of server records has been successfully retrieved. | |
500 | 1020 | An error has occurred while trying to retrieve the requested servers. |
Response Description
A list of the servers. A server record contains the following fields:
hostname - String - hostname
managed_host_id - Number - Id of the managed host the server host belongs to
private_ip - String - The private ip of this server
status - String - The status of this server
Response Sample
[ { "hostname": "String", "managed_host_id": 42, "private_ip": "String", "server_id": 42, "status": "String" } ]
GET /system/servers/{server_id}
Retrieve a server host based on the supplied server ID.
Table 24: GET /system/servers/{server_id} Resource Details
MIME Type |
|---|
application/json |
Table 25: GET /system/servers/{server_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The id of the server |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 26: GET /system/servers/{server_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The requested server record has been retrieved. | |
404 | 1002 | The requested server record with the given server_id cannot be found. |
422 | 1005 | One or more parameters are invalid in request. |
500 | 1020 | An error has occurred while trying to retrieve the requested server host with the given Id. |
Response Description
A server record containing the following fields:
email_server_address - String - email server address
hostname - String - hostname
managed_host_id - Number - Id of the managed host the server host belongs to
private_ip - String - The private ip of this server
status - String - The status of this server
Response Sample
{ "email_server_address": "String", "hostname": "String", "managed_host_id": 42, "private_ip": "String", "server_id": 42, "status": "String" }
POST /system/servers/{server_id}
Updates an existing server.
Table 27: POST /system/servers/{server_id} Resource Details
MIME Type |
|---|
application/json |
Table 28: POST /system/servers/{server_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The id of the server. |
Table 29: POST /system/servers/{server_id} Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
details | Object | application/json | Required - A server details record containing the following field: email_server_address - String - email server address. Must be a valid server address that the server can connect to through port 25. | { "email_server_address": "String" } |
Table 30: POST /system/servers/{server_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The server record has been updated. | |
404 | 1002 | The requested server record with the given server_id cannot be found. |
422 | 1005 | One or more parameters are invalid in request. |
422 | 1006 | Cannot connect to the mail server address on port 25. |
500 | 1020 | An error has occurred while trying to retrieve the requested server host with the given Id. |
Response Description
The updated server record containing the following fields:
email_server_address - String - email server address.
hostname - String - hostname
managed_host_id - Number - Id of the managed host the server host belongs to
private_ip - String - The private ip of this server
status - String - The status of this server
Response Sample
{ "email_server_address": "String", "hostname": "String", "managed_host_id": 42, "private_ip": "String", "server_id": 42, "status": "String" }
GET /system/servers/{server_id}/firewall_rules
Retrieve a list of access control firewall rules based on the supplied server ID.
Table 31: GET /system/servers/{server_id}/firewall_rules Resource Details
MIME Type |
|---|
application/json |
Table 32: GET /system/servers/{server_id}/firewall_rules Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The id of the server. |
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 33: GET /system/servers/{server_id}/firewall_rules Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The rules records have been retrieved. | |
404 | 1002 | The requested server with the given server_id cannot be found. |
422 | 1005 | One or more parameters are invalid in request. |
500 | 1020 | An error has occurred while trying to retrieve the requested access control firewall rules on the server with the given Id. |
Response Description
A list of the rules. Each rule record contains the following fields:
is_any_source_ip - Boolean - Whether any source IP is accepted
port_range - String - A port range in the format of start-end
port_type - String - one of: ANY, SINGLE, RANGE
protocol - String - one of: ANY, TCP, UDP
single_port - String - A single port
source_ip - String - A specific IP address
Response Sample
[ { "is_any_source_ip": true, "port_range": "String", "port_type": "String <one of: ANY, SINGLE, RANGE>", "protocol": "String <one of: ANY, TCP, UDP>", "single_port": "String", "source_ip": "String" } ]
PUT /system/servers/{server_id}/firewall_rules
Set the access control firewall rules based on the supplied server ID.
Table 34: PUT /system/servers/{server_id}/firewall_rules Resource Details
MIME Type |
|---|
application/json |
Table 35: PUT /system/servers/{server_id}/firewall_rules Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The id of the server. |
Table 36: PUT /system/servers/{server_id}/firewall_rules Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
rules | Array<Object> | application/json | Required - A list of new rules in a JSON string. Each rule record contains the following field:
| [ { "is_any_source_ip": true, "port_range": "String", "port_type": "String <one of: ANY, SINGLE, RANGE>", "protocol": "String <one of: ANY, TCP, UDP>", "single_port": "String", "source_ip": "String" } ] |
Table 37: PUT /system/servers/{server_id}/firewall_rules Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The rules have been updated. | |
404 | 1002 | The requested server with the given server_id cannot be found. |
422 | 1005 | One or more parameters are invalid in request. |
500 | 1020 | An error has occurred while trying to set the access control firewall rules on the server with the given Id. |
Response Description
A list of the rules in a JSON string. Each rule contains the following fields:
is_any_source_ip - Boolean - Whether any source IP is accepted
port_range - String - A port range in the format of start-end
port_type - String - one of: ANY, SINGLE, RANGE
protocol - String - one of: ANY, TCP, UDP
single_port - String - A single port
source_ip - String - A specific IP address
Response Sample
[ { "is_any_source_ip": true, "port_range": "String", "port_type": "String <one of: ANY, SINGLE, RANGE>", "protocol": "String <one of: ANY, TCP, UDP>", "single_port": "String", "source_ip": "String" } ]
GET /system/servers/{server_id}/network_interfaces/bonded
Retrieves a list of the bonded network interfaces based on the supplied server ID.
Table 38: GET /system/servers/{server_id}/network_interfaces/bonded Resource Details
MIME Type |
|---|
application/json |
Table 39: GET /system/servers/{server_id}/network_interfaces/bonded Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The id of the server. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
Table 40: GET /system/servers/{server_id}/network_interfaces/bonded Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | A list of the bonded network interfaces were retrieved. | |
404 | 1002 | The requested server with the given server ID cannot be found. |
422 | 1005 | One or more parameters are invalid in request. |
500 | 1020 | An error occurred while trying to retrieve the bonded interfaces on the server with the given ID. |
500 | 1022 | Timeout while performing the task. |
Response Description
A list of the bonded network interfaces. Each record contains the following fields:
device_name - String - The name of the network interface.
desc - String - The description of the network interface.
role - String - The role of the network interface. One of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled.
ipversion - String - The verson of the IP address configured on the network interface. One of: ipv4, ipv6.
ip - String - The IP address that is configured on the network interface.
mask - String - The netmask that is configured on the network interface.
is_auto_ip - Boolean - Is the IP address auto-configured?
is_cable_linked - String - Is the network interface cable linked? One of: YES, NO, UNKNOWN
is_moving_config_with_active_ha - Boolean - Will apply the same settings to a new active HA server during failover.
hacrossover_params - String - A map of key-value pairs of HA crossover parameters if the network interface is used for HA crossover.
bonding_opts - String - The bonding options that are configured on the bonded network interface.
slaves - List - The slaves of the bonded network interface. Each slave record contains the follow fields:
device_name - String - The name of the slave interface.
desc - String - The description of the slave interface.
role - String - The role of the slave interface. One of: slave, slave_disabled
is_cable_linked - String - Is the slave interface cable linked. One of: true, false, unknown
Response Sample
[ { "bonding_opts": "String", "desc": "String", "device_name": "String", "hacrossover_params": { "String": "String" }, "ip": "String", "ipversion": "String <one of: ipv4, ipv6>", "is_auto_ip": true, "is_cable_linked": "String <one of: true, false, unknown>", "is_moving_config_with_active_ha": true, "mask": "String", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>", "slaves": [ { "desc": "String", "device_name": "String", "is_cable_linked": "String <one of: true, false, unknown>", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>" } ] } ]
POST /system/servers/{server_id}/network_interfaces/bonded
Creates a new bonded network interface.
Table 41: POST /system/servers/{server_id}/network_interfaces/bonded Resource Details
MIME Type |
|---|
application/json |
Table 42: POST /system/servers/{server_id}/network_interfaces/bonded Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The ID of the server. |
Table 43: POST /system/servers/{server_id}/network_interfaces/bonded Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
details | Object | application/json | Required - The details of the bonded network interface that contains the following fields:
| { "bonding_opts": "String", "ip": "String", "ipversion": "String <one of: ipv4, ipv6>", "is_auto_ip": true, "is_moving_config_with_active_ha": true, "mask": "String", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>", "slaves": [ { "device_name": "String" } ] } |
Table 44: POST /system/servers/{server_id}/network_interfaces/bonded Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
201 | The bonded network interface was created. | |
404 | 1002 | The requested server with the given server_id cannot be found. |
409 | 1004 | The ip address has been used by another network interface. |
422 | 1005 | One or more parameters are invalid in request. |
500 | 1020 | An error occurred while trying to create the bonded interface on the server with the given ID. |
500 | 1022 | Timeout while performing the task. |
Response Description
The created bonded network interface that contains the following fields:
device_name - String - The name of the network interface.
role - String - The role of the network interface. One of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled.
ipversion - String - The verson of the IP address that is configured on the network interface. One of: ipv4, ipv6.
ip - String - The Ip address that is configured on the network interface.
mask - String - The netmask that is configured on the network interface.
is_auto_ip - Boolean - Is the Ip address auto-configured?
is_moving_config_with_active_ha - Boolean - Applies the same settings to a new active HA server during failover.
bonding_opts - String - The bonding options that are configured on the bonded network interface.
slaves - Array - The slave ethernet interfaces of the bonded interface. Each slave interface has one field: device_name. The device_name must be an existing ethernet interface that cannot be the management interface, the HA crossover interface or a slave interface of another bonded network interface. The array must contain at least one ethernet interface.
Response Sample
{ "bonding_opts": "String", "desc": "String", "device_name": "String", "hacrossover_params": { "String": "String" }, "ip": "String", "ipversion": "String <one of: ipv4, ipv6>", "is_auto_ip": true, "is_cable_linked": "String <one of: true, false, unknown>", "is_moving_config_with_active_ha": true, "mask": "String", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>", "slaves": [ { "desc": "String", "device_name": "String", "is_cable_linked": "String <one of: true, false, unknown>", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>" } ] }
POST /system/servers/{server_id}/network_interfaces/bonded/{device_name}
Updates an existing bonded network interface.
Table 45: POST /system/servers/{server_id}/network_interfaces/bonded/{device_name} Resource Details
MIME Type |
|---|
application/json |
Table 46: POST /system/servers/{server_id}/network_interfaces/bonded/{device_name} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The ID of the server. |
device_name | path | Required | String | text/plain | Required - The name of an existing bonded network interface. The interface cannot be the management interface or HA crossover interface. The interface must be cable linked. |
Table 47: POST /system/servers/{server_id}/network_interfaces/bonded/{device_name} Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
details | Object | application/json | Required - The details of the bonded network interface that contains the following fields:
| { "bonding_opts": "String", "ip": "String", "ipversion": "String <one of: ipv4, ipv6>", "is_auto_ip": true, "is_moving_config_with_active_ha": true, "mask": "String", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>", "slaves": [ { "device_name": "String" } ] } |
Table 48: POST /system/servers/{server_id}/network_interfaces/bonded/{device_name} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The bonded network interface was updated. | |
404 | 1002 | The requested server with the given server ID cannot be found. |
409 | 1004 | The ip address has been used by another network interface. |
422 | 1005 | One or more parameters are invalid in request. |
500 | 1020 | An error occurred while trying to update the specified bonded interfaces on the server with the given ID. |
500 | 1022 | Timeout while performing the task. |
Response Description
The updated bonded network interface that contains the following fields:
device_name - String - The name of the network interface.
role - String - The role of the network interface. One of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled.
ipversion - String - The verson of the IP address that is configured on the network interface. one of: ipv4, ipv6
ip - String - The IP address that is configured on the network interface.
mask - String - The netmask that is configured on the network interface.
is_auto_ip - Boolean - Is the IP address auto-configured?
is_moving_config_with_active_ha - Boolean - Applies the same settings to a new active HA server during failover.
bonding_opts - String - The bonding options that are configured on the bonded network interface.
slaves - Array - The slave ethernet interfaces of the bonded interface. Each slave interface has two fields: device_name and role. The role is slave or slave_disabled.
Response Sample
{ "bonding_opts": "String", "desc": "String", "device_name": "String", "hacrossover_params": { "String": "String" }, "ip": "String", "ipversion": "String <one of: ipv4, ipv6>", "is_auto_ip": true, "is_cable_linked": "String <one of: true, false, unknown>", "is_moving_config_with_active_ha": true, "mask": "String", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>", "slaves": [ { "desc": "String", "device_name": "String", "is_cable_linked": "String <one of: true, false, unknown>", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>" } ] }
DELETE /system/servers/{server_id}/network_interfaces/bonded/{device_name}
Removes a bonded network interface.
Table 49: DELETE /system/servers/{server_id}/network_interfaces/bonded/{device_name} Resource Details
MIME Type |
|---|
text/plain |
Table 50: DELETE /system/servers/{server_id}/network_interfaces/bonded/{device_name} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The ID of the server. |
device_name | path | Required | String | text/plain | Required - The device name of the bonded network interface. |
Table 51: DELETE /system/servers/{server_id}/network_interfaces/bonded/{device_name} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The bonded network interface was removed. | |
404 | 1002 | The requested server with the given server ID or the bonded network interface cannot be found. |
422 | 1005 | One or more parameters are invalid in request. |
500 | 1020 | An error occurred while trying to remove the bonded interface on the server with the given ID. |
500 | 1022 | Timeout while performing the task. |
Response Description
Response Sample
GET /system/servers/{server_id}/network_interfaces/ethernet
Retrieves a list of the ethernet network interfaces based on the supplied server ID.
Table 52: GET /system/servers/{server_id}/network_interfaces/ethernet Resource Details
MIME Type |
|---|
application/json |
Table 53: GET /system/servers/{server_id}/network_interfaces/ethernet Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The id of the server. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
Table 54: GET /system/servers/{server_id}/network_interfaces/ethernet Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | A list of the ethernet network interfaces were retrieved. | |
404 | 1002 | The requested server with the given server ID cannot be found. |
422 | 1005 | One or more parameters are invalid in request. |
500 | 1020 | An error occurred while trying to retrieve the ethernet interfaces on the server with the given ID. |
500 | 1022 | Timeout while performing the task. |
Response Description
A list of the ethernet network interfaces. Each ethernet network interface contains the following fields:
device_name - String - The name of the network interface.
desc - String - The description of the network interface.
role - String - The role of the network interface. One of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled.
ipversion - String - The verson of the IP address that is configured on the network interface. One of: ipv4, ipv6.
ip - String - The IP that is configured on the network interface.
mask - String - The netmask that is configured on the network interface
is_auto_ip - Boolean - Is the IP auto-configured?
is_cable_linked - String - Is the network interface cable linked? One of: true, false, unknown.
is_moving_config_with_active_ha - Boolean -Applies the same settings to a new active HA server during failover.
hacrossover_params - String - A map of key-value pairs of HA crossover parameters if the network interface is used for HA crossover.
Response Sample
[ { "desc": "String", "device_name": "String", "hacrossover_params": { "String": "String" }, "ip": "String", "ipversion": "String <one of: ipv4, ipv6>", "is_auto_ip": true, "is_cable_linked": "String <one of: true, false, unknown>", "is_moving_config_with_active_ha": true, "mask": "String", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>" } ]
POST /system/servers/{server_id}/network_interfaces/ethernet/{device_name}
Updates an ethernet network interface based on the suppied server_Id and device_name.
Table 55: POST /system/servers/{server_id}/network_interfaces/ethernet/{device_name} Resource Details
MIME Type |
|---|
application/json |
Table 56: POST /system/servers/{server_id}/network_interfaces/ethernet/{device_name} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The ID of the server. |
device_name | path | Required | String | text/plain | Required - The name of an existing ethernet network interface. The interface cannot be the management interface, HA crossover interface or a slave of a bonded interface. The interface must be cable linked. |
Table 57: POST /system/servers/{server_id}/network_interfaces/ethernet/{device_name} Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
details | Object | application/json | Required - An ethernet network interface record containing the following fields:
| { "ip": "String", "ipversion": "String <one of: ipv4, ipv6>", "is_auto_ip": true, "is_moving_config_with_active_ha": true, "mask": "String", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>" } |
Table 58: POST /system/servers/{server_id}/network_interfaces/ethernet/{device_name} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The network interface has been updated. | |
404 | 1002 | The requested server with the given server ID cannot be found. |
409 | 1004 | The ip address has been used by another network interface. |
422 | 1005 | One or more parameters are invalid in request. |
500 | 1020 | An error occurred while trying to update the specified ethernet interfaces on the server with the given ID. |
500 | 1022 | Timeout while performing the task. |
Response Description
The updated ethernet network interface containing the following fields:
device_name - String - The name of the network interface.
role - String - The role of the network interface. One of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled.
ipversion - String - The verson of the that is IP address that is configured on the network interface. One of: ipv4, ipv6.
ip - String - The IP address that is configured on the network interface.
mask - String - The netmask configured on the network interface.
is_auto_ip - Boolean - Is the IP address auto-configured.
is_moving_config_with_active_ha - Boolean - Applies the same settings to a new active HA server during failover.
Response Sample
{ "desc": "String", "device_name": "String", "hacrossover_params": { "String": "String" }, "ip": "String", "ipversion": "String <one of: ipv4, ipv6>", "is_auto_ip": true, "is_cable_linked": "String <one of: true, false, unknown>", "is_moving_config_with_active_ha": true, "mask": "String", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>" }
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.
Table 59: GET /system/servers/{server_id}/system_time_settings Resource Details
MIME Type |
|---|
application/json |
Table 60: GET /system/servers/{server_id}/system_time_settings Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The ID of the server. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 61: GET /system/servers/{server_id}/system_time_settings Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The requested system time settings record was retrieved. | |
404 | 1002 | The requested system time settings record with the given server ID cannot be found. |
422 | 1005 | One or more parameters are invalid in the request. |
500 | 1020 | An error occurred during the attempt to retrieve the requested system time settings with the given server ID. |
500 | 1022 | Timeout while performing the task. |
Response Description
Server system time settings that contain the following fields:
timezone_id - String - the current time zone
current_time - Long - The current epoch time (number of milliseconds after Epoch).
is_sync_with_ntp_server - Boolean - Whether the NTP service is used to synchronize the system time with configured NTP time servers.
ntp_server_addresses - Array - The array of the configured NTP server addresses. Null if is_sync_with_ntp_server is false.
Response Sample
{ "current_time": 42, "ntp_server_addresses": [ "String" ], "sync_with_ntp_server": true, "timezone_id": "String" }
POST /system/servers/{server_id}/system_time_settings
Sets the system time and time zone settings of a server host. Services are restarted after the call and service interruptions will occur.
Table 62: POST /system/servers/{server_id}/system_time_settings Resource Details
MIME Type |
|---|
application/json |
Table 63: POST /system/servers/{server_id}/system_time_settings Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The ID of the server |
fields | header | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 64: POST /system/servers/{server_id}/system_time_settings Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
settings | Object | application/json | Server system time settings that contain the following fields:
| { "current_time": 42, "ntp_server_addresses": [ "String" ], "sync_with_ntp_server": true, "timezone_id": "String" } |
Table 65: POST /system/servers/{server_id}/system_time_settings Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The system time settings have been applied. | |
404 | 1002 | The requested server with the given server ID cannot be found. |
422 | 1005 | One or more parameters are invalid in request. |
500 | 1020 | An error occurred during the attempt to apply the system time settings to the server. |
500 | 1022 | Timeout during performance of the task. |
Response Description
Server system time settings that contain the following fields:
timezone_id - String - The current time zone.
current_time - Long - The current epoch time (number of milliseconds after Epoch).
is_sync_with_ntp_server - Boolean - Whether the NTP service is used to synchronize the system time with configured NTP time servers.
ntp_server_addresses - Array - The array of the configured NTP server addresses. Null if is_sync_with_ntp_server is false.
Response Sample
{ "current_time": 42, "ntp_server_addresses": [ "String" ], "sync_with_ntp_server": true, "timezone_id": "String" }
GET /system/servers/{server_id}/timezones
Retrieves all the available time zones that can be set for a server.
Table 66: GET /system/servers/{server_id}/timezones Resource Details
MIME Type |
|---|
application/json |
Table 67: GET /system/servers/{server_id}/timezones Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
server_id | path | Required | Number (Integer) | text/plain | Required - The ID of the server |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 68: GET /system/servers/{server_id}/timezones Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The requested timezone records were retrieved. | |
404 | 1002 | The requested timezone records with the given server ID cannot be found. |
422 | 1005 | One or more parameters are invalid in the request. |
500 | 1020 | An error occurred during the attempt to retrieve the requested timezone records with the given server Id. |
500 | 1022 | Timeout during the performance of the task. |
Response Description
A list of time zones that contains the following fields:
id - String - the ID of time zone.
timezone - String - The formatted string representation of the timezone in the current locale.
offset - Integer - Number of milliseconds offset to UTC time at the moment.
Response Sample
[ { "id": "String", "offset": 42, "timezone": "String" } ]