Update the Splunk instance with cluster details

This operation is used to update the Splunk Instance properties with the masternode and peer cluster details

Path Parameters

instanceId integer required
Id of the Splunk instance to be browsed

application/json

Request Body required

Request Body

instanceProperties object
excludeFromSLA boolean
instance object
instanceId integer
clientId integer
applicationId integer
distributedClusterInstance object
clusterType integer
opType integer
instance object
instanceName string
instanceId integer
clusterConfig object
splunkConfig object
primaryNode object
entity object
clientId integer
clientName string
splunkUserCredInfo object
credentialId integer
credentialName string
url string

Responses

application/json

Schema
Example (from schema)
Update Splunk Instance with Splunk peer nodes

Schema

instanceProperties object
excludeFromSLA boolean
instance object
instanceId integer
clientId integer
applicationId integer
distributedClusterInstance object
clusterType integer
opType integer
instance object
instanceName string
instanceId integer
clusterConfig object
splunkConfig object
nodes object[]
entity object
clientId integer
clientName string
primaryNode object
path string
entity object
clientId integer
clientName string
splunkUserCredInfo object
url string

{
  "instanceProperties": {
    "excludeFromSLA": true,
    "instance": {
      "instanceId": 0,
      "clientId": 0,
      "applicationId": 0
    },
    "distributedClusterInstance": {
      "clusterType": 0,
      "opType": 0,
      "instance": {
        "instanceName": "string",
        "instanceId": 0
      },
      "clusterConfig": {
        "splunkConfig": {
          "nodes": [
            {
              "entity": {
                "clientId": 0,
                "clientName": "string"
              }
            }
          ],
          "primaryNode": {
            "path": "string",
            "entity": {
              "clientId": 0,
              "clientName": "string"
            }
          },
          "splunkUserCredInfo": {},
          "url": "string"
        }
      }
    }
  }
}

{
  "instanceProperties": {
    "excludeFromSLA": false,
    "instance": {
      "instanceId": 210,
      "clientId": 212,
      "applicationId": 64
    },
    "distributedClusterInstance": {
      "clusterType": 16,
      "opType": 2,
      "instance": {
        "instanceName": "splunk cluster clientname",
        "instanceId": 210
      },
      "clusterConfig": {
        "splunkConfig": {
          "nodes": [
            {
              "entity": {
                "clientId": 178,
                "clientName": "first peer node clientname"
              }
            },
            {
              "entity": {
                "clientId": 179,
                "clientName": "second peer node clientname"
              }
            }
          ],
          "primaryNode": {
            "path": "",
            "entity": {
              "clientId": 177,
              "clientName": "master node clientname"
            }
          },
          "splunkUserCredInfo": {},
          "url": "https://xx.xx.xx.xx:8089"
        }
      }
    }
  }
}

Bad Request

application/json
application/xml

Schema
Example

Schema

string

Request body is empty or format is invalid

Schema
Example (from schema)

Schema

object

<root/>

Unauthorized

application/json

Schema
Example (from schema)
Example

Schema

errorMessage string
errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

Update the Splunk instance with cluster details​

Update the Splunk instance with cluster details