Skip to main content
PUT
/
subscriptions
/
{platformType}
/
properties
Replace existing properties (bulk PUT)
curl --request PUT \
  --url https://{host}/subscriptions/{platformType}/properties \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "propertyRef": "<string>",
    "propertyName": "<string>",
    "aliasName": "<string>",
    "owner": "<string>"
  }
]
'
import requests

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

payload = [
    {
        "propertyRef": "<string>",
        "propertyName": "<string>",
        "aliasName": "<string>",
        "owner": "<string>"
    }
]
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      propertyRef: '<string>',
      propertyName: '<string>',
      aliasName: '<string>',
      owner: '<string>'
    }
  ])
};

fetch('https://{host}/subscriptions/{platformType}/properties', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'propertyRef' => '<string>',
        'propertyName' => '<string>',
        'aliasName' => '<string>',
        'owner' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

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

func main() {

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

	payload := strings.NewReader("[\n  {\n    \"propertyRef\": \"<string>\",\n    \"propertyName\": \"<string>\",\n    \"aliasName\": \"<string>\",\n    \"owner\": \"<string>\"\n  }\n]")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://{host}/subscriptions/{platformType}/properties")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"propertyRef\": \"<string>\",\n    \"propertyName\": \"<string>\",\n    \"aliasName\": \"<string>\",\n    \"owner\": \"<string>\"\n  }\n]")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"propertyRef\": \"<string>\",\n    \"propertyName\": \"<string>\",\n    \"aliasName\": \"<string>\",\n    \"owner\": \"<string>\"\n  }\n]"

response = http.request(request)
puts response.read_body
[
  {
    "propertyRef": "<string>",
    "propertyName": "<string>",
    "aliasName": "<string>",
    "owner": "<string>"
  }
]

Path Parameters

​
platformType
enum<string>
required

Platform catalog (cloud or containers).

Available options:
cloud,
containers

Body

application/json
Minimum array length: 1
​
propertyRef
string
required
​
propertyName
string
required
​
aliasName
string
​
owner
string

Response

200 - application/json

Updated properties

​
propertyRef
string
required

Unique referenced ID.

​
propertyName
string
required

Recommendation element name (must exist in the applicable Recommendations response schema).

​
aliasName
string

Display alias (scope-unique per rules).

​
owner
string

Empty = global; otherwise username (private).