# Deep Security Manager REST API

## Path: / rest / tenants / state / {state}

Get tenants by tenant state

Path parameters:
  state - Tenant state. Currently supported states are:
  - undefined (Default state)
  - created (Tenant is created)
  - active (Tenant is active)
  - suspended (Tenant is suspended)
  - pending-deletion (Tenant is pending to be deleted)
  - db-upgrade-failure (Tenant database upgrade failure)
  - confirmation-required (Tenant confirmation is required)
  - cache-requires-initialization (Cached tenant is pending to be initialized)
  - cache-initializing (Cached tenant is initializing)
  - cache-ready-for-use (Cached tenant is ready for use)
  - cache-activating (Cached tenant is activating)

Method Summary
Resource | Description
--- | ---
`GET /rest/tenants/state/{state}?sID=…&tenantID=…&tenantIDOp=…&maxItems=…` | Get tenants by tenant state

Method Detail
Get tenants by tenant state Output: `TenantListing` - a {@link TenantListing} with the tenant details. Query parameters: sID tenantID - (optional) used to define the starting point for the query. Combine with `tenantIDOp` to page through results. tenantIDOp - (optional, required if `tenantID` is specified) Currently-supported operations are: gt (greater than) ge (greater than or equal to) eq (equal to) lt (less than) le (less than or equal to) maxItems - (optional) the number of items to retrieve. The maximum value for this parameter is controlled by the "Maximum number of items to retrieve from database" setting on the administrator account, which defaults to 5000. Produces: application/xml application/json HTTP return codes: 200 - if the request is successful. 400 - if tenant state is invalid. 403 - if the user is not authorized with Multi-Tenant manage right.

Copyright © 2017 Trend Micro Inc. All Rights Reserved.