Skip to content
Alberto Gonzalez edited this page Oct 29, 2015 · 1 revision

(PUT)/systems

Description

Updates specific fields for a system in the management grid. This API does not modify the system role; to make role changes, specific APIs must be called. For example, to promote a replicating system to a managed replicating system the (PUT)/api/systems/add-management API is used.

Request

Syntax

PUT /api/systems
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

Name Description Type Required
name system name string optional (1)
id system id long always
ip ip address of the system string optional (2)
location_id location_id of the system long optional (3)

1- this is the user's view of the system name, not the host name 2- this is the local system's /etc/host entry for that system's ip, this does not change the actual ip address of the system 3- this option and multiple locations are not supported in Release 9.0.

Response

The API returns either success (HTTP: OK) or fails with status 500 and an error code and message.

Parameters

Examples

Sample Request

PUT api/systems
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

data passed in:

{
   "id" : 1,
   "location_id": 2
}

Sample Response

HTTP Status: 200 (OK)

Failed system modification will return HTTP Status 500 with a result object with an error message and KB link as defined here

Clone this wiki locally