This API call deletes a specific VLAN configuration from the DDI Central database based on its unique identifier (primary key). It helps administrators remove VLANs that are no longer needed.
Note: When this API call deletes a VLAN, the VLAN configuration is permanently removed from the DDI Central database. However, the underlying subnet associated with the VLAN remains intact retaining its DHCP and routing functionalities., continuing to function independently without VLAN-specific configurations.
Devices within the underlying subnet can still communicate, but the VLAN-based segmentation is no longer applied. This way the API ensures that VLAN clean-up does not impact subnet availability, allowing administrators to manage network configurations efficiently.
Method: DELETE
https://{appconsole_IP}:{9443}/api/dhcp/vlanmgmt_pk/{pk}/
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" }
* - Mandatory parameter.
Copied
{
"message": "Deleted successfully"
}