Cascade DELETE.

POST

/api/web/namespaces/{name}/cascade_delete

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/example/cascade_delete \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

• F5 Distributed Cloud Console

CascadeDelete will DELETE the namespace and all configuration objects like virtual_hosts etc. Under it. Use this only if the entire namespace and its contents are to be wiped out.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

name

required

string

Name The name of the namespace.

Request Body^required

Media typeapplication/json

CascadeDeleteRequest

CascadeDeleteRequest contains the name of the namespace that has to be deleted along with the objects configured under the namespace.

object

name

name

The name of the namespace.

string

>= 6 characters <= 1024 characters

Example^generated

{
  "name": "example"
}

Responses

200

A successful response.

Media typeapplication/json

CascadeDeleteResponse

CascadeDeleteResponse contains a list of objects in the namespace that were deleted (or encountered an error while deleting)

object

items

items

The objects deleted in namespace.

Array<object>

CascadeDeleteItemType

CascadeDeleteItemType is details of object that was handled as part of cascade DELETE of namespace and whether it was successfully deleted.

object

error_message

error_message

A description of the error encountered (if any) in the process of cascade deletion.

string

<= 1024 characters

object_name

object_name

Name of the configuration object that was deleted.

string

<= 1024 characters

object_type

object_type

The type of the contained configuration object in the namespace that was deleted.

string

<= 1024 characters

object_uid

object_uid

The UID identifier of the configuration object that was deleted.

string

<= 1024 characters

Example^generated

{
  "items": [
    {
      "error_message": "example",
      "object_name": "example",
      "object_type": "example",
      "object_uid": "example"
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example