Create Cluster Config

POST 
/clustersconfig/

Use this endpoint to create a cluster config. If a cluster config is successfully created, the response will include the cluster config id.

Fields

Name	Required
name	yes
settings	no

Settings

Name	Required
attributeName	yes
displayType	yes
priority	no

Request

application/json

Body

name string

settings

object[]

Array [

attributeName string

displayType string

priority number

]

Responses

201

Create Cluster Config - 201

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

id number

name string

settings

object[]

Array [

attributeName string

clusterConfigId number

displayType string

id number

priority number

]

messages string[]
total number

Example (from schema)

{
  "data": {
    "id": 11,
    "name": "LINEAR_CLUSTER",
    "settings": [
      {
        "attributeName": "PROPELLER_COLOR",
        "clusterConfigId": 11,
        "displayType": "color",
        "id": 115,
        "priority": 1
      }
    ]
  },
  "messages": [
    "Cluster Config created"
  ],
  "total": 1
}

Create Cluster Config - 201

{
  "data": {
    "id": 11,
    "name": "LINEAR_CLUSTER",
    "settings": [
      {
        "attributeName": "PROPELLER_COLOR",
        "clusterConfigId": 11,
        "displayType": "color",
        "id": 115,
        "priority": 1
      }
    ]
  },
  "messages": [
    "Cluster Config created"
  ],
  "total": 1
}

400

Create Cluster Config - 400

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": 21004,
    "messages": [
      "Cluster Config with name [LINEAR_CLUSTER] already exists. Please provide unique name."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/21004",
    "status": 400,
    "type": "ClusterConfigExists"
  }
}

Create Cluster Config - 400

{
  "error": {
    "code": 21004,
    "messages": [
      "Cluster Config with name [LINEAR_CLUSTER] already exists. Please provide unique name."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/21004",
    "status": 400,
    "type": "ClusterConfigExists"
  }
}

Loading...