Release an IP address

Use this operation to release an IP address from a network resource pool.

HTTP method and URI path

POST /zosmf/resource-mgmt/rest/<version>/rdp/network/ip/release

In this request:

<version>: Is the URI path variable that identifies the version of the z/OSMF service. The following value is valid: 1.0.

Query parameters

None.

Description

This operation releases an IP address from a network resource pool, calling through the tenant's resource pool.

On successful completion, HTTP status code 204 (No content) is returned, indicating that the request resulted in an IP address being released.

Request content

The request content is expected to contain a JSON object that describes the IP address to be released. See Table 1.

Table 1. Request content for the release IP address request
Field name	Type	Required or optional	Description
tenant-id	String	Required	ID of the tenant that is associated with the resource pool. Derived from workflow internal variable, ${_workflow-tenantID}.
network-parms	JSON object	Required	Network parameters for the request. See Table 2.

Table 2. Network parameters fields
Field	Type	Required or optional	Description
ip-id	String	Required	Identifier of the IP address. This is returned as the id property in an Obtain an IP address request.

Authorization requirements

The user must be a consumer in the tenant, or a network administrator in the domain that the tenant is associated with.

For more information, see Authorization requirements.

HTTP status codes

On successful completion, HTTP status code 204 (No content) is returned.

Otherwise, the following HTTP status codes are returned for the indicated errors. The response body is a standard error response body that provides the reason code that is indicated and associated error message.

Table 3. HTTP error response codes for a release IP address request
HTTP error status code	Description
`HTTP 500 Internal server error`	The server encountered an error. See the response body for a JSON object with information about the error.

Response content

None.

Example HTTP interaction

In Figure 1, a request is submitted to release an IP address.

Figure 1. Sample request to release an IP address, with the request body

POST https://localhost:4444/zosmf/resource-mgmt/rest/1.0/rdp/network/ip/release

{
     "tenant-id":"IYU0AA",
     "network-parms":
     {
           "ip-id":"1001"          
         }
 }