/scalemgmt/v3/nsds/{nsd_name}: DELETE

Deletes the specified NSD.

Availability

Available on all IBM Storage Scale editions.

Description

The DELETE nsds/{nsd_name} request deletes an existing NSD. To run this command, you must have the RBAC permission for the delete action on the /scalemgmt/v3/nsds resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/nsds/{nsd_name}
where
{nsd_name}
Specifies the name of the NSD.

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
nsd_name The name of the NSD. Required.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 200: A successful response and the NSD was deleted.
    {}
  • default: An unexpected error response.
    {
      "code": 0,
      "details": [
        {
          "@type": "string",
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      ],
      "message": "string"
    }

Examples

The following example deletes the nsd_1 NSD:

Request data:
curl  -n -k -X DELETE  https://localhost:46443/scalemgmt/v3/nsds/nsd_1 -H 'accept: application/json'   -H 'Content-Type: application/json'
Response data:
{}