Overview

DescriptionDeactivate a specific activated tenant.
Resource Path

/tenants/deactivate/{tenantDomain}

HTTP MethodPUT
Request/Response Formatapplication/json
> PUT /api/tenants/deactivate/franky.com HTTP/1.1
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8| zlib/1.2.5
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
>
< HTTP/1.1 200 OK
< Date: Tue, 17 Mar 2015 09:52:57 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"status":"success","message":"Tenant deactivated successfully: [tenant] franky.com"} 
curl -X PUT -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/tenants/deactivate/{tenantDomain}

  • By default, <STRATOS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <STRATOS_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.

CLI command
deactivate-tenant
DescriptionDeactivate a currently active tenant.
Command format
deactivate-tenant <TENANT_DOMAIN>

REST API response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

  • No labels