Add Setting to Cluster Config

POST 
/clustersconfig/:lookupKey/:lookupValue/settings

Use this endpoint to add additional settings to a cluster config. If a cluster config setting is successfully created, the response will include the id.

Fields

Name	Required
attributeName	yes
displayType	yes
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)

application/json

Body

attributeName string
displayType string
priority number

Responses

201

Add Setting to Cluster Config - 201

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

attributeName string

clusterConfigId number

displayType string

id number

priority number
messages string[]
total number

Example (from schema)

{
  "data": {
    "attributeName": "PROPELLER_SIZE",
    "clusterConfigId": 11,
    "displayType": "dropdown",
    "id": 116,
    "priority": 2
  },
  "messages": [
    "Cluster Config Setting created"
  ],
  "total": 1
}

Add Setting to Cluster Config - 201

{
  "data": {
    "attributeName": "PROPELLER_SIZE",
    "clusterConfigId": 11,
    "displayType": "dropdown",
    "id": 116,
    "priority": 2
  },
  "messages": [
    "Cluster Config Setting created"
  ],
  "total": 1
}

404

Add Setting to Cluster Config - 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": 14001,
    "messages": [
      "Attribute with name [PROPELLER_SIZE111] and attributeClass [product] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/14001",
    "status": 404,
    "type": "AttributeNotFound"
  }
}

Add Setting to Cluster Config - 404

{
  "error": {
    "code": 14001,
    "messages": [
      "Attribute with name [PROPELLER_SIZE111] and attributeClass [product] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/14001",
    "status": 404,
    "type": "AttributeNotFound"
  }
}

Loading...