--- title: "List details of the tenant" method: GET path: "/_api/tenant/{tenant}" tags: ["Administration"] --- # List details of the tenant `GET /_api/tenant/{tenant}` ## Request - The document declares no server URL. - Auth: one of: - API key in header `Authorization` - HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Fetch information about the tenant. **Note**: Requires *administrator* permissions. ## Path parameters - `tenant` string, string, required ## Response `200` Successfully fetched tenant. - GetTenantExampleRc200 - `code` integer: HTTP response code. - `error` boolean: Flag if there is an error in response. *False* for this response. - `result` GetTenantResultValue - `limits` TenantLimitsValue - `apiServer` ApiServerLimitsExample - `maxRequestPerMinute` integer: Rate limiting at the gateway proxy. This value indicates the maximum number of requests per minute for a tenant, including all http/https requests for any component coming from a regions LoadBalancer. If the value is 0, rate limiting is disabled. - `cep` CepLimitsExample: The limits values for CEP feature - `maxPublishedWorkers` integer: Max number of published workers. - `maxWorkersMemoryMB` integer: Max total memory size in MB of all the stream workers for the tenant. - `maxMemoryMBPerWorker` integer: Max memory size in MB per stream worker for the tenant. - `maxWorkersCpuSecondsPerMinute` integer: Max CPU seconds per minute for stream worker - `maxWorkersThroughputInMBPerMinute` integer: Max IN throughput per minute in MB for stream workers. - `maxWorkersThroughputOutMBPerMinute` integer: Max OUT throughput per minute in MB for stream workers. - `maxLogsLengthKBPerMinutePerWorker` integer: Max logs length per minute in KB for each stream worker. - `maxCpuSecondsPerMinutePerWorker` integer: Max CPU seconds per minute for each stream worker.54 - `database` DatabaseLimitsExample - `maxDocumentSize` integer: The maximum document size in bytes. - `maxDocumentsReturnedByQuery` integer: The maximum documents returned by a query, or 0 to disable this limit. The page size for the query is equal to this value (if set), preventing c8db from creating a persistent cursor for queries. - `maxQueryExecutionTimeInMs` integer: The maximum time allowed for a query to complete processing. - `maxQueryMemoryBytes` integer: The maximum bytes of memory allowed to be used by a query during processing. - `maxGeoFabricsPerTenant` integer: The maximum number of fabric a tenant can create. Use 0 to disable. - `maxCollectionsPerFabric` integer: The maximum number of collections per fabric a tenant can create. Use 0 to disable. - `maxGraphsPerFabric` integer: The maximum number of graph collections per fabric a tenant can create. Use 0 to disable. - `maxIndexes` integer: The maximum number of indexes per fabric a tenant can create. Use 0 to disable. - `maxViewsPerFabric` integer: The maximum number of views per fabric a tenant can create. Use 0 to disable. - `maxRequestsPerDay` integer: The maximum number of API requests per day for a tenant, including UI requests to the APIs. Use 0 to disable. This only applies for tenants with the 'tenant.trial' property in _tenants set to *true*. - `maxStoragePerRegion` integer: The maximum storage (in bytes) allowed to be used by a tenant in a region. Use 0 to disable. This only applies for tenants with the 'FREE' billing plan. **Note**: As the metadata is also get counted in storage size calculation, the required storage size could be more than the total documents size stored in database. - `maxRestQLUsagePerFabric` integer: The maximum number of RestQL queries per fabric a tenant can run in a day. Use 0 to disable. - `maxRestQLUsagePerDay` integer: The maximum number of RestQL requests can be ran by a tenant in a day. Use 0 to disable. - `maxDocumentsImportedPerAPICall` integer: The maximum number of documents a tenant can import in a single API call. Use 0 to disable. - `eventhub` EventhubLimitsExample: The limits values for eventhub feature - `maxEventhubProducersCount` integer: Max eventhub producers count. - `maxEventhubConsumersCount` integer: Max eventhub consumers count - `streamsGlobal` StreamsLimitsExample - `maxStreamsCount` integer: Max streams count. - `maxProducersCount` integer: Max streams producer count. - `maxConsumersCount` integer: Max streams consumer count. - `maxSubscriptionsCount` integer: Max streams subscriptions count. - `maxBacklogMessageTTLMin` integer: Max streams backlog messagaes TTL in minute. - `maxBacklogStorageSizeMB` integer: Max streams backlog storage size in MB. - `maxDispatchThrottlingRateInByte` integer: Max streams byte dispatch rate per minute. - `streamsLocal` StreamsLimitsExample - `maxStreamsCount` integer: Max streams count. - `maxProducersCount` integer: Max streams producer count. - `maxConsumersCount` integer: Max streams consumer count. - `maxSubscriptionsCount` integer: Max streams subscriptions count. - `maxBacklogMessageTTLMin` integer: Max streams backlog messagaes TTL in minute. - `maxBacklogStorageSizeMB` integer: Max streams backlog storage size in MB. - `maxDispatchThrottlingRateInByte` integer: Max streams byte dispatch rate per minute. - `dataMeshIntegration` DmiLimitsExample: The limits values for Data Mesh Integrations feature. - `maxConnections` integer: Max number of connections. - `maxWorkflows` integer: Max number of workflows. - `tenant` string: Name of the tenant. - `status` string, string: Availability of tenant. - `spotDc` string, string: The Edge Location (data center) where on-spot operations for the given GeoFabric is performed. By default, a random data center is chosen from those which are capable. - `realTime` boolean: For this tenant, whether the changes are published in a real time streams. - `name` string, string: Name of the tenant with fabric name as a suffix. - `clusters` string[]: List of data centers in tenant. - `dynamo_local_tables` boolean: Flag indicator for dynamo_local_tables. - `attribution` string, string: Attribution of the tenant. - `features` FeaturesListWithAvailabilityFlagExample[]: List of features with boolean value indicating that those features are enabled or not. - `CEP` boolean: Name of the CEP feature. - `DOCS` boolean: Name of the Docs feature. - `DYNAMO` boolean: Name of the Dynamo feature. - `REDIS` boolean: Name of the Redis feature. - `GEO_FABRICS` boolean: Name of the Geo Fabrics feature. - `GRAPHS` boolean: Name of the Graphs feature. - `KV` boolean: Name of the KV feature. - `LOCAL_COLLECTIONS` boolean: Name of the Local Collections feature. - `STREAMS` boolean: Name of the streams feature. - `USERS` boolean: Name of the Users feature. - `EVENT_HUB` boolean: Name of the EventHub feature. - `plan` string, string: Name of the billing plan. - `metadata` object: Object with metadata key-value pairs. - `dnsInfo` DnsInfoResponse - `global_url` string: The global URL for the tenant and fabric pair. - `regional_urls` object: Populates the regional URLs. - `region-name-1` string: The regional URL for the tenant and fabric pair for data center 1. - `region-name-2` string: The regional URL for the tenant and fabric pair for data center 2. - `status` object: Status of the regional URLs. - `region-name-1` string: Status of the regional URL for data center 1. Available status - enabled, disabled, pending, error - `region-name-2` string: Status of the regional URL for data center 2. Available status - enabled, disabled, pending, error - `err_msg` string: The error message for the failure during the DNS record CRUD operations. ## Other responses - `401`: Failed because you do not have administrator permissions. - `403`: Failed to validate because you do not have access to the server. - `404`: Failed to find specified tenant. --- [API](https://skmtc.dev/macrometa/apis/macrometa-api-reference.md) - [All operations](https://skmtc.dev/macrometa/apis/macrometa-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/macrometa/apis/macrometa-api-reference/revisions/2006b6d7f31d?raw)