Description

This article describes how you can use the REST API to remove an IPv4 Range from the SNAT Exclusion List.

Note that the REST client used for demonstration purposes in this article may differ somewhat from yours but the basic functions should be common. Please refer to REST API Client Requirements for the CloudControl API for an overview of the REST client requirements for CloudControl APIs.

Prerequisites:

  1. User must have Primary Administrator or Network role
  2. Network Domain must be in a NORMAL state
  3. Data Center cannot be in Networking maintenance.
  4. SYSTEM IPv4 SNAT Exclusions can only be deleted on an Enterprise Network Domain
    1. This includes any SYSTEM SNAT Exclusion, including one associated with a non-RFC 1918 VLAN
  5. Input must be a valid ID that exists on the Network Domain

Other requirements to use this API function:

  1. You must have a REST client installed on your computer
  2. You must know the ID of the SNAT Exclusion you want to delete. See How to View the Network Domain SNAT Exclusion List using Rest API

Content / Solution:

  1. Open your desired REST client and Set the HTTP Request to the POST method:


  2. Set the Authorization Type to Basic Auth:


  3. Enter the Username and Password for the Cloud account:

    Note: These are the same credentials you use to login to the Updated UI

  4. Navigate to the Headers tab and set the following Headers:

    Key: Authorization

    • Value: Basic

    Key: Content-Type

    • Value: application/json

  5. Enter the API Request URL in the address bar of the REST Client:

    https://<Cloud API Host>/caas/2.9/{orgid}/network/removeSnatExclusion

    Note: The Cloud API Host address can be found in the Support and Additional URLs dashboard. See Support and Additional URLs

  6. Replace "<Cloud API Host>" with the appropriate Cloud API URL, and replace "{orgid}" with your organization ID:

    Note: Be sure to remove any brackets around the Cloud API URL and the ORG ID.

  7. Navigate to the Body portion of the REST Client, and select "raw":



  8. Enter the body of the API request:

    {
    "id": "<SNAT Exclusion id>"
    }

    Note: Be sure to remove the <angle brackets> from around the input
    Note: The resource ID can be found by using the view/list SNAT Exclusion function. see How to View the Network Domain SNAT Exclusion List using Rest API

  9. Enter the SNAT Exclusion ID in the body of the request, then Click Send:


  10. The response will be displayed in the Response section of the REST Client: