Developer Guide

2.5.0
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0

Back Next

Create Node Groups

Use the POST method to create a node group in EDS.

POST Request in JSON Format

Generate a POST request. For example, the following POST request creates a node group:

POST /api/nodegroups

Content-Type: application/json
Accept: application/json

POST Body in JSON Format

{ 
    "name": "TestNodeGroup", 
    "type": "STATIC", 
    "nodes": [1, 2, 3]
}

POST Response in JSON Format

The following is a sample response for the 201 Created code:

{
  "id": 322,
  "name": "NodeGroup2",
  "success": true,
  "type": "STATIC",
  "nodes": [
    {
      "id": 253
    }
  ]
}

The following is a sample response for the 400 Bad Request code:

{
    "success": false,
    "errors": 
        [
            {
            "code": NAME_FIELD_MISSING,
            "parameters": null,
            "errorMessage": "'name' field is missing in request"
            }
        ]
}

{
    "success": false,
    "errors": 
        [
            {
            "code": UNSUPPORTED_NODEGROUP_TYPE,
            "parameters": [{invalid-nodegroup-type}],
            "errorMessage": "Unsupported node group type:  {invalid-nodegroup-type}. Valid node group types (static, dynamic)"
            }
        ]
}

{
    "success": false,
    "errors": 
        [
            {
            "code": PATTERN_FIELD_MISSING,
            "parameters": null,
            "errorMessage": "'pattern' (regex) field is missing request. It is required for 'dynamic' Node group"
            }
        ]
}

{
    "success": false,
    "errors": 
        [
            {
            "code": NODE_NOT_FOUND,
            "parameters": [{node-id}],
            "errorMessage": "Node not found with Id: {node-id}"
            }
        ]
}

{
    "success": false,
    "errors": 
        [
            {
            "code": NODEGROUP_ALREADY_EXISTS,
            "parameters": null,
            "errorMessage": "Node group name already exists."
            }
        ]
}

The following is a sample response for the 500 Internal Server Error code:

{
    "success": false,
    "errors": 
        [
            {
            "code": INTERNAL_SERVER_ERROR,
            "parameters": [{error-message}],
            "errorMessage": ""Failed to create Node. Error: {error-message}"
            }
        ]

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Create Node Groups

Create Node Groups

POST Request in JSON Format

POST Body in JSON Format

POST Response in JSON Format