Boomi Platform API Reference (1.0.0) - NodeOffboard

Toggle Pane

• NodeOffboard
  • postCreates a NodeOffboard object

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

NodeOffboard

As a Cloud or Runtime cluster owner, use the Node Offboard object to programatically delete nodes from a Cloud or Runtime cluster cluster.

The Node Offboard object performs similarly to how you might use the Delete button on the Cluster Status panel in Runtime Management to remove a node. You must have Runtime Management privileges to use the Node Offboard object.

Creates a NodeOffboard object

Employs a POST method to delete a node. After you successfully perform the POST operation, the nodes status immediately changes to Deleting on the Cluster Status panel of the interface.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

atomId	string A unique, -generated identifier assigned to the Runtime cluster or Runtime cloud. In the  user interface, this ID appears on the Runtime Information panel of Runtime Management.
nodeId	Array of strings The ID of the Runtime cluster or Cloud node that is intended for deletion. In the  user interface, this ID appears on the Cluster Status panel of Runtime Management.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

atomId	string A unique, -generated identifier assigned to the Runtime cluster or Runtime cloud. In the  user interface, this ID appears on the Runtime Information panel of Runtime Management.
nodeId	Array of strings The ID of the Runtime cluster or Cloud node that is intended for deletion. In the  user interface, this ID appears on the Cluster Status panel of Runtime Management.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/NodeOffboard

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "NodeOffboard",
• "nodeId": [

  • "node1"

  ],
• "atomId": "3456789a-bcde-f012-3456-789abcdef012"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "NodeOffboard",
• "nodeId": [

  • "node1"

  ],
• "atomId": "3456789a-bcde-f012-3456-789abcdef012"

}