Delete one or more user-defined templates

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Permanently deletes the specified configuration templates. This action is irreversible.

Request URL

https://{server-hostname}:8383/dcapi/configuration/template

Scope

Common.DELETECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/deleteTemplate.v1+jsonapplication/deleteTemplate.v1+jsonCopied!
AcceptstringMandatory
application/deleteTemplateStatus.v1+jsonapplication/deleteTemplateStatus.v1+jsonCopied!

- Request Body

application/json
JSON object
Hide Sub-Attributes
templateIdsarrayOptional

Array of template IDs to delete. Each must be a valid user-defined template belonging to the requesting customer. Maximum 500 entries.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request DELETE \
  --url https://appdomain/dcapi/configuration/template \
  --header 'Accept: application/deleteTemplateStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/deleteTemplate.v1+json' \
  --data '{"templateIds":[1001,1002,1003]}'
Show full

Sample Request Body

Delete multiple configuration templates

Copied!
  {
    "templateIds": [
      1001,
      1002,
      1003
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
statusstring

Result of the delete templates operation

deletedCountstring

Number of templates successfully deleted

- HTTP code 400

Response Body - application/json
JSON object
Hide Sub-Attributes
error_codestring

BAD_REQUEST: template IDs are invalid, belong to another customer, or are system templates that cannot be deleted

error_descriptionstring

Message describing the template validation failure

- HTTP code 401

Response Body - application/json
JSON object
Hide Sub-Attributes
errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code

Sample Response: HTTP 200

Templates deleted successfully

Copied!
  {
    "deletedCount": 3,
    "status": "Success"
  }
                
Show full

Sample Response: HTTP 400

Template IDs are invalid or belong to another customer

Copied!
  {
    "error_description": "Invalid template IDs or templates belong to another customer",
    "error_code": "BAD_REQUEST"
  }
                
Show full

Sample Response: HTTP 401

User lacks write role or attempting to delete system templates

Copied!
  {
    "error_description": "Access denied - You are not allowed to access the requested resource.",
    "error_code": "UAC_UNAUTHORIZED"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.