Delete system variables

Use this operation to delete z/OSMF system variables from the system variable pool.

HTTP method and URI path

DELETE /zosmf/variables/rest/<version>/systems/<sysplex-name>.<system-name>

In this request, the URI path variables are described, as follows:

<version> identifies the version of the z/OSMF system variables service. The following value is valid: 1.0.
<sysplex-name> identifies the sysplex.
<system-name> identifies the system.

Description

This operation removes system variables from the system variable pool.

If all variables are removed, the system variable pool is empty. If there is no request body, this operation deletes the system variable pool. If the request body contains an empty array ([ ]), no action is taken. If the request body contains no variables in the array, no action is taken. If the request body contains variables that does not exist in the pool, those variables are ignored.

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

Authorization requirements

See Authorization requirements.

Request content

The request content is expected to contain an array of strings. Each string represents the name of a system variable to delete.

HTTP status codes

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

If the system variable pool does not exist for the requested system, HTTP status code 204 is returned.

Otherwise, the following HTTP status codes are returned for the indicated errors.

Table 1. HTTP error response codes for a create system variables request
HTTP error status code	Description
`400`	Request body is not formatted correctly
`401`	Submitter of the request is not authorized to delete the system variables
`404`	Requested system was not found
`500`	A server error occurred during processing of the request.

Response content

None.

Example HTTP interaction

In the following example, the DELETE method is used to delete system variables from a system variable pool.

Figure 1. Sample request to delete system variables

DELETE /zosmf/variables/rest/1.0/variables/systems/<sysplex-name>.<system-name>

The request body is as follows:

Figure 2. Sample request body for a delete system variables request

["var1","var2",...]