Delete Cluster by lookup key

DELETE 
/clusters/:lookupKey/:lookupValue

Use this endpoint to delete cluster by lookup key.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

Responses

200

Delete Cluster by lookup key - 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 deleted"
  ]
}

Delete Cluster by lookup key - 200

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

404

Delete Cluster 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": 20006,
    "messages": [
      "Cluster with id [213] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20006",
    "status": 404,
    "type": "ClusterNotFound"
  }
}

Delete Cluster by lookup key - 404

{
  "error": {
    "code": 20006,
    "messages": [
      "Cluster with id [213] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20006",
    "status": 404,
    "type": "ClusterNotFound"
  }
}

Loading...