This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • 4.1.x Getting Details of a Tenant via the REST API
Skip to end of metadata
Go to start of metadata


DescriptionRetrieve details of a tenant. Based on the response it will be possible to decide whether a certain domain name is available or not.
Resource Path/tenants/{tenantDomain}
Request/Response Formatapplication/json

> GET /api/tenants/ 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 08:47:03 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server

The createdDate is given in the Epoch time format.

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/tenants/{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


DescriptionRetrieve details of a specific tenant.
Command format

describe-tenant <TENANT_DOMAIN_NAME>


REST API response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

  "active": true,
  "admin": "admin2",
  "createdDate": 1426576793551,
  "email": "",
  "firstname": "Franky",
  "lastname": "Myers",
  "tenantDomain": "",
  "tenantId": 2,
  "usagePlan": ""

For information on the property definitions, see Tenant Resource Definition.

  • No labels