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

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


Activating a tenant via the CLI

CLI command
DescriptionActivate a currently deactivated tenant.
Command format
activate-tenant <TENANT_DOMAIN>
Parameter definition
Short optionLong optionDescriptionRequiredExample value

Activate the tenant with the domain: 

Sample output
You have successfully activated the tenant:

Activating a tenant via the REST API

DescriptionActivate a specific deactivated tenant.
Resource Path/tenants/activate/{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/activate/{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.

Activate the tenant with the domain: 

curl -X PUT -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/tenants/activate/
Sample output
> PUT /api/tenants/activate/ 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:01:36 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
{"status":"success","message":"Tenant activated successfully: [tenant]"}

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

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Activating a tenant via the PPaaS Console

Follow the instructions below to activate a Tenant:

When you add a new tenant, by default it gets created as an activated account. You need to activate a tenant only if it was deactivated previously.

Only users who belong to the admin user role will be allowed to activate a tenant in WSO2 PPaaS.

  1. Click Users on the home page.
  2. Click Manage Tenants.
  3. Click Activate to activate a tenant that has been deactivated.
  4. Click Yes to activate the tenant.




  • No labels