
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# POST devices/removalJob

Delete one or more devices through a batch job.

Since Product Version: 3.1

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Write
HTTP Methods | POST

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/op/devices/removalJob

## Request Payload Parameters

Attribute | Description
--- | ---
deleteAPs boolean | Delete access points associated to wireless controllers. When not provided or 'false', then associated access points will not be deleted and remain in "unassociated" state. Note, that thirdparty access points will be deleted regardless of the property value.
ipAddressList InetAddress[] | Required List of addresses of the devices to be deleted. Either the hostname, the IP address, or the management address can be passed in. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.

## Response Parameters

Attribute | Description
--- | ---
jobName String | The unique job name for this job
jobType String | The non-unique job type for this job

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://10.64.88.203/webacs/api/v1/op/devices/removalJob

    <?xml version="1.0" ?>
    <removalJobParamsDTO>
      <deleteAPs>true</deleteAPs>
      <ipAddressList>
        <ipAddressList>
          <address>192.168.115.243</address>
        </ipAddressList>
        <ipAddressList>
          <address>192.168.115.244</address>
        </ipAddressList>
      </ipAddressList>
    </removalJobParamsDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v1/op/devices/removalJob.json

    {
      "removalJobParamsDTO" : {
        "deleteAPs" : true,
        "ipAddressList" : {
          "ipAddressList" : [{
            "address" : "192.168.115.243"
          },
          {
            "address" : "192.168.115.244"
          }]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v1/op/devices/removalJob

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v1/op">
      <removalJobResultDTO>
        <jobName>String value</jobName>
        <jobType>String value</jobType>
      </removalJobResultDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v1/op/devices/removalJob.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/devices/removalJob",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
        "removalJobResultDTO" : {
          "jobName" : "String value",
          "jobType" : "String value"
        }
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Write
HTTP Methods | POST

## Resource URL

/webacs/api/v2/op/devices/removalJob

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
deleteAPs boolean | Delete access points associated to wireless controllers. When not provided or 'false', then associated access points will not be deleted and remain in "unassociated" state. Note, that thirdparty access points will be deleted regardless of the property value.
ipAddressList InetAddress[] | Required List of addresses of the devices to be deleted. Either the hostname, the IP address, or the management address can be passed in. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.

## Response Parameters

Attribute | Description
--- | ---
jobName String | The unique job name for this job
jobType String | The non-unique job type for this job

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://10.64.88.203/webacs/api/v2/op/devices/removalJob

    <?xml version="1.0" ?>
    <removalJobParamsDTO>
      <deleteAPs>true</deleteAPs>
      <ipAddressList>
        <ipAddressList>
          <address>192.168.115.243</address>
        </ipAddressList>
        <ipAddressList>
          <address>192.168.115.244</address>
        </ipAddressList>
      </ipAddressList>
    </removalJobParamsDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v2/op/devices/removalJob.json

    {
      "removalJobParamsDTO" : {
        "deleteAPs" : true,
        "ipAddressList" : {
          "ipAddressList" : [ {
            "address" : "192.168.115.243"
          }, {
            "address" : "192.168.115.244"
          } ]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v2/op/devices/removalJob

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v2/op">
      <removalJobResultDTO>
        <jobName>String value</jobName>
        <jobType>String value</jobType>
      </removalJobResultDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/devices/removalJob.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
        "removalJobResultDTO" : [ {
          "jobName" : "String value",
          "jobType" : "String value"
        } ]
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Write
HTTP Methods | POST

## Resource URL

/webacs/api/v3/op/devices/removalJob

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
deleteAPs boolean | Delete access points associated to wireless controllers. When not provided or 'false', then associated access points will not be deleted and remain in "unassociated" state. Note, that thirdparty access points will be deleted regardless of the property value.
ipAddressList InetAddress[] | Required List of addresses of the devices to be deleted. Either the hostname, the IP address, or the management address can be passed in. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.

## Response Parameters

Attribute | Description
--- | ---
jobName String | The unique job name for this job
jobType String | The non-unique job type for this job

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://10.64.88.203/webacs/api/v3/op/devices/removalJob

    <?xml version="1.0" ?>
    <removalJobParamsDTO>
      <deleteAPs>true</deleteAPs>
      <ipAddressList>
        <ipAddressList>
          <address>192.168.115.243</address>
        </ipAddressList>
        <ipAddressList>
          <address>192.168.115.244</address>
        </ipAddressList>
      </ipAddressList>
    </removalJobParamsDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v3/op/devices/removalJob.json

    {
      "removalJobParamsDTO" : {
        "deleteAPs" : true,
        "ipAddressList" : {
          "ipAddressList" : [ {
            "address" : "192.168.115.243"
          }, {
            "address" : "192.168.115.244"
          } ]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v3/op/devices/removalJob

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v3/op">
      <removalJobResultDTO>
        <jobName>String value</jobName>
        <jobType>String value</jobType>
      </removalJobResultDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v3/op/devices/removalJob.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
        "removalJobResultDTO" : [ {
          "jobName" : "String value",
          "jobType" : "String value"
        } ]
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Write
HTTP Methods | POST

## Resource URL

/webacs/api/v4/op/devices/removalJob

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
deleteAPs boolean | Delete access points associated to wireless controllers. When not provided or 'false', then associated access points will not be deleted and remain in "unassociated" state. Note, that thirdparty access points will be deleted regardless of the property value.
ipAddressList InetAddress[] | Required List of addresses of the devices to be deleted. Either the hostname, the IP address, or the management address can be passed in. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.

## Response Parameters

Attribute | Description
--- | ---
jobName String | The unique job name for this job
jobType String | The non-unique job type for this job

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://10.64.88.203/webacs/api/v4/op/devices/removalJob

    <?xml version="1.0" ?>
    <removalJobParamsDTO>
      <deleteAPs>true</deleteAPs>
      <ipAddressList>
        <ipAddressList>
          <address>192.168.115.243</address>
        </ipAddressList>
        <ipAddressList>
          <address>192.168.115.244</address>
        </ipAddressList>
      </ipAddressList>
    </removalJobParamsDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v4/op/devices/removalJob.json

    {
      "removalJobParamsDTO" : {
        "deleteAPs" : true,
        "ipAddressList" : {
          "ipAddressList" : [ {
            "address" : "192.168.115.243"
          }, {
            "address" : "192.168.115.244"
          } ]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v4/op/devices/removalJob

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v4/op">
      <removalJobResultDTO>
        <jobName>String value</jobName>
        <jobType>String value</jobType>
      </removalJobResultDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v4/op/devices/removalJob.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
        "removalJobResultDTO" : [ {
          "jobName" : "String value",
          "jobType" : "String value"
        } ]
      }
    }