Delete Option by Cluster lookup key and Option Id

DELETE 
/clusters/:lookupKey/:lookupValue/options/:optionId

Use this endpoint to delete single cluster option by cluster lookup key and option id.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

optionId stringrequired

The value of option id

Responses

200

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

Delete Option by Cluster lookup key and Option Id - 200

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

404

Delete Option by Cluster lookup key and Option Id - 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": 20010,
    "messages": [
      "Cluster Option with id [216] not found for the cluster with id [213]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20010",
    "status": 404,
    "type": "ClusterOptionNotFound"
  }
}

Delete Option by Cluster lookup key and Option Id - 404

{
  "error": {
    "code": 20010,
    "messages": [
      "Cluster Option with id [216] not found for the cluster with id [213]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20010",
    "status": 404,
    "type": "ClusterOptionNotFound"
  }
}

Loading...