Farm topology members (DELETE)

Unregisters a farm node.

Description

This service removes a farm node By default, the service will remove a farm node only if it is marked as being Down If you want to force the deletion, even if the farm member is marked as being Alive, you should set the force argument to true.

Roles

Users in the following roles are authorized to perform this operation:

  • worklightadmin

Method

DELETE

Path

/management-apis/1.0/runtimes/runtime-name/farm/server-id

Example

https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/farm/farm_member_1?force=false&locale=de_DE

Path Parameters

runtime-name
The name of the runtime. This is the context root of the runtime web application, without the leading slash.
server-id
The server id of the farm member to remove

Query Parameters

Query parameters are optional.

force
Whether the service should unregister a farm member, even if it is marked as being Alive. The default is false.
locale
The locale used for error messages.

Produces

application/json, application/xml, text/xml

Response

The status of the unregistration of the farm member

JSON Example

{
  "ok" : true,
  "productVersion" : "7.0",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<remove-farm-member-result
  ok="true"
  productVersion="7.0"/>

Response Properties

The response has the following properties:

ok
Whether the operation was successful.
productVersion
The exact product version.

Errors

403
The user is not authorized to call this service.
404
The corresponding farm member is not found.
500
An internal error occurred.