This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Deactivating a Tenant - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You can deactivate a tenant using the CLI tool, REST API or the PPaaS Console as shown below:


Deactivating a tenant via the CLI

CLI command
DescriptionDeactivate a currently active tenant.
Command format
deactivate-tenant <TENANT_DOMAIN>
Parameter definition
Short optionLong optionDescriptionRequiredExample value

Deactivate the tenant with the domain: 

Sample output
You have successfully deactivated the tenant:

Deactivating a tenant via the REST API

DescriptionDeactivate a currently activate tenant.
Resource Path/tenants/deactivate/{tenantDomain}
Request/Response Formatapplication/json
Command format
curl -X POST -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/tenants/deactivate/{tenantDomain}
  • By default, <USERNAME>:<PASSWORD> is admin:admin.
  • By default, <PRIVATE_PAAS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <PRIVATE_PAAS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Deactivate the tenant with the domain: 

curl -X PUT -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/tenants/deactivate/
Sample output
> PUT /api/tenants/deactivate/ HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
< HTTP/1.1 200 OK
< Date: Wed, 14 Oct 2015 13:07:30 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
* Connection #0 to host localhost left intact
{"status":"success","message":"Tenant deactivated successfully: [tenant]"}

You will come across the following HTTP status codes while deactivating a tenant:

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Deactivating a tenant via the PPaaS Console

Follow the instructions below to deactivate a tenant:

  1. Click Users on the home page.
  2. Click Manage Tenants.
  3. Click Deactivate to deactivate the selected tenant. 
  4. Click Yes to deactivate the tenant.




  • No labels