Update request and response

RESTful API for IBM® Spectrum Control Base Edition uses update requests for partial object update.

You can update an object by issuing the HTTP PATCH command on a full URL. The request must contains a single object, which is the target of the update request.

For example, PATCH /api/v1/interfaces/26 entered with the parameters detailed below, changes the name and IP address of the interface 26.

name aaac
address 3.3.3.5

The response to the update request is as follows:

  • OK, followed by the updated object, if the task is completed successfully
  • An error message with a status code, detailing a reason for the failed request, as illustrated below.
{
    "detail": "IP address specified for the default gateway is not in the subnet of 
			the IP Interface"
}