Delete a property by ID

Returns 204 on success; 404 if not found; if referenced by a subscription, returns propertyRef, message, and status.

DELETE /subscriptions/{platformType}/properties/{propertyRef}

Delete a property by ID

cURL

curl --request DELETE \
  --url https://{host}/subscriptions/{platformType}/properties/{propertyRef}

import requests

url = "https://{host}/subscriptions/{platformType}/properties/{propertyRef}"

response = requests.delete(url)

print(response.text)

const options = {method: 'DELETE'};

fetch('https://{host}/subscriptions/{platformType}/properties/{propertyRef}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/subscriptions/{platformType}/properties/{propertyRef}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/subscriptions/{platformType}/properties/{propertyRef}"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://{host}/subscriptions/{platformType}/properties/{propertyRef}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/subscriptions/{platformType}/properties/{propertyRef}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

200

{
  "propertyRef": "<string>",
  "message": "<string>",
  "status": 123
}

Path Parameters

platformType · enum<string> · required

Platform catalog (cloud or containers).

Available options: cloud, containers

propertyRef · string · required

Unique property identifier.

Response

200

application/json

In-use error payload

propertyRef · string

message · string

status · integer

HTTP-like code (200, 204, 400, 404, 500).