Skip to content

DeactivateTenant.

PUT
/api/saas/namespaces/system/v2/tenant/deactivate
curl --request PUT \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/saas/namespaces/system/v2/tenant/deactivate \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "feedback": "example", "reason": "REASON_UNKNOWN" }'

This API mark tenant for deletion queue, after approve it will completely removed from the system. This API proxies the request to eywa’s tenant disable API.

Examples of this operation.

Media typeapplication/json
DeactivateTenantRequest

Request to deactivate the tenant.

object
feedback
Feedback

Feedback from the customer related to reason of account deactivation.

string
<= 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
DeactivateTenantResponse
object
job_id
Job Id

Job ID of the async job that triggered to process the tenant deactivation.

string
<= 1024 characters
Examplegenerated
{
"job_id": "example"
}

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