Update Cluster Config Setting

PATCH 
/clustersconfig/:lookupKey/:lookupValue/settings/:settingId

Use this endpoint to update a setting on the cluster config by cluster config lookup key and setting id. Attrubute name can't be updated.

Fields

Name	Required
displayType	no
priority	no

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster config lookup keys

lookupValue stringrequired

The value of the key (id or name)

settingId stringrequired

The id of cluster config setting

application/json

Body

displayType string

Responses

200

Update Cluster Config Setting - 200

Response Headers

• Alt-Svc

  string

• Content-Length

  string

• Via

  string

• alt-svc

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

displayType string

id number
messages string[]
total number

Example (from schema)

{
  "data": {
    "displayType": "radio",
    "id": 116
  },
  "messages": [
    "Cluster Config Setting updated"
  ],
  "total": 1
}

Update Cluster Config Setting - 200

{
  "data": {
    "displayType": "radio",
    "id": 116
  },
  "messages": [
    "Cluster Config Setting updated"
  ],
  "total": 1
}

404

Update Cluster Config Setting - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 21007,
    "messages": [
      "Cluster config setting with id [117] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/21007",
    "status": 404,
    "type": "ClusterConfigSettingNotFound"
  }
}

Update Cluster Config Setting - 404

{
  "error": {
    "code": 21007,
    "messages": [
      "Cluster config setting with id [117] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/21007",
    "status": 404,
    "type": "ClusterConfigSettingNotFound"
  }
}

Loading...