DELETE - Delete a DDNS or DHCP Zone by ID

Purpose

This API call permanently removes a specific DHCP or DDNS zone configuration from the DDI Central database. This helps administrators remove DDNS zones that are no longer needed.

Note: This API ensures a controlled removal of DHCP or DDNS zone configurations while preserving critical DNS functionality.

When a DHCP or DDNS zone is deleted, all DHCP settings associated with the zone will be permanently lost. As a result, the zone will no longer support dynamic IP updates from DHCP clients or any other DHCP-related operations, and the ddns parameter for the zone will be set to false.

However, the zone and its DNS configurations will remain functional, preserving any static DNS records that were previously configured. Additionally, the zone will retain the last updated DDNS records, including the most recent IP addresses assigned before the DHCP zone configurations were deleted.

Request URL

Method: DELETE

https://{appconsole_IP}:{9443}/api/dhcp/zone_data_pk/{pk}/

Request Headers

The following headers must be included in the API request for successful authentication and data submission:

Authorization: DDI Central's OAuth implementation uses the Bearer authentication scheme. Hence, while making API calls, access_token obtained via the OAuth 2.0 Client Credentials Grant must be included in the Authorization header of API requests. This token verifies the client’s identity and ensures appropriate permissions for accessing resources.

The Authorization Header follows the format below:

headers = { "Authorization": "Bearer {bearer_tk}" }


Content-Type: Required in the header to indicate the media type of the resource being sent. It helps the server at the receiving end understand how to process the transmitted request body.

The Content-Type Header follows the format below:

headers ={ "Content-Type": "application/json" }

Path Parameters

  • pk* long
    • Denotes the unique identifier of the DDNS Zone to be deleted.

 

- Mandatory parameter.

 

Sample Response

Copied
{
  "message": "Deleted successfully"
}