Remove Setting from Cluster Config

DELETE 
/clustersconfig/:lookupKey/:lookupValue/settings/:settingId

Use this endpoint to delete a setting on the cluster config by cluster config lookup key and setting id.

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

Responses

200

Remove Setting from Cluster Config - 200

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

data

object

object
messages string[]

Example (from schema)

{
  "data": {},
  "messages": [
    "Cluster Config setting deleted"
  ]
}

Remove Setting from Cluster Config - 200

{
  "data": {},
  "messages": [
    "Cluster Config setting deleted"
  ]
}

404

Remove Setting from Cluster Config - 404

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

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"
  }
}

Remove Setting from Cluster Config - 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...