Skip to content

DELETE Tenant.

POST
/api/web/namespaces/system/tenant/request-delete
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/system/tenant/request-delete \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "email": "hello@example.com", "feedback": "example", "name": "example", "reason": "REASON_UNKNOWN" }'

Request to mark Tenant for deletion queue, after approve it will completely removed from the system.

Examples of this operation.

Media typeapplication/json
DeleteTenantRequest

Request for marking Tenant for deletion.

object
email
Email

Email of freemium account which need to be deleted.

string format: email
<= 1024 characters /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/
feedback
Feedback

Feedback from the customer related to reason of account deletion.

string
<= 1024 characters
name
Name

Tenant name marked for deletion.

string
>= 6 characters <= 1024 characters
reason
string
default: REASON_UNKNOWN
Allowed values: REASON_UNKNOWN REASON_SWITCH_TO_FREE_PLAN REASON_NO_LONGER_NEEDED REASON_NOT_JUSTIFY_COSTS REASON_DIFFICULT_TO_USE

A successful response.

Media typeapplication/json

LookupCnameResponse sets the response format based on the availability of cname.

It can return any of these three types of errors. EEXISTS => cname exists. EOK => valid request. However, cname does not exist. EUNKNOWN => internal error in fetching tenants info.

object
Examplegenerated
{}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

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

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example