DELETE - Delete a specific shared network

Purpose

The API deletes a specific shared network within a Windows cluster environment. 

Note: if there are subnets associated with the shared network, the API will first prompt the user to delete them. Only after all associated subnets have been removed can the shared network configuration be deleted from DDI Central.

This API ensures structured network cleanup by preventing accidental deletions and helps administrators remove unused shared networks while ensuring all dependencies are properly addressed before deletion.

Request URL

https://{appconsole_IP}:{9443}/api/dhcp/shared_network_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
    • This denotes the unique identifier for the shared network.

 

* - Mandatory parameter.

 

Sample Response

Copied{
"message":"Deleted successfully"
}