Delete preset domain group

Permanently deletes a preset domain group along with all domains belonging to that group.

Reference

DELETE https://YOUR-NETWORK-DOMAIN/rest-api/preset-domain/group/delete.do

Permanently deletes a preset domain group along with all domains belonging to that group. The group must exist or a 404 error is returned. A group that targeting rules of non-deleted entities still use is refused with a 409 listing them under usages, unless force=true: then those rules are deleted with the group and removedTargetingRules says how many. Requires PRESET_DOMAIN_GROUP_MANAGEMENT permission. The action is recorded in the audit log.

Form Params

groupId integer required

Unique numeric ID of the preset domain group to delete

100

force boolean

true to delete the group although targeting rules of non-deleted entities still use it; those rules are deleted with it. Without it such a group is refused with 409 and the entities are listed

false

Responses

200

Success

400

Missing required parameter

401

Unauthorized

403

Forbidden

404

Preset group not found

409

Targeting rules of non-deleted entities still use the group and force was not set; usages lists the entities

500

Internal server error

Language

cURL Request

curl --request DELETE \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/preset-domain/group/delete.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'groupId=100' \
  --data-urlencode 'force=false'

Python Request

import requests

response = requests.request("DELETE", "https://YOUR-NETWORK-DOMAIN/rest-api/preset-domain/group/delete.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"groupId": "100", "force": "false"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/preset-domain/group/delete.do', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"groupId":"100","force":"false"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/preset-domain/group/delete.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("DELETE", HttpRequest.BodyPublishers.ofString("groupId=100&force=false"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("DELETE"), "https://YOUR-NETWORK-DOMAIN/rest-api/preset-domain/group/delete.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["groupId"] = "100", ["force"] = "false" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://YOUR-NETWORK-DOMAIN/rest-api/preset-domain/group/delete.do", strings.NewReader(`groupId=100&force=false`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

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

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/preset-domain/group/delete.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'groupId=100&force=false');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/preset-domain/group/delete.do")
request = Net::HTTP::Delete.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('groupId' => "100", 'force' => "false")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body