Get Cluster Config by lookup key

GET 
/clustersconfig/:lookupKey/:lookupValue

Use this endpoint to retrieve cluster config details by lookup key.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster config lookup keys

lookupValue stringrequired

The value of the key (id or name)

Query Parameters

expands string

Optional. Use settings to retrieve the settings details of the cluster config.

Responses

200

Get Cluster Config by lookup key - 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

id number

name string

settings

object[]

Array [

attributeName string

clusterConfigId number

displayType string

id number

priority string

]

messages undefined[]
total number

Example (from schema)

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

Get Cluster Config by lookup key - 200

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

404

Get Cluster Config by lookup key - 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": 21005,
    "messages": [
      "Cluster Config with id [12] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/21005",
    "status": 404,
    "type": "ClusterConfigNotFound"
  }
}

Get Cluster Config by lookup key - 404

{
  "error": {
    "code": 21005,
    "messages": [
      "Cluster Config with id [12] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/21005",
    "status": 404,
    "type": "ClusterConfigNotFound"
  }
}

Loading...