Administration

Set the default tenant limits

Set the default tenant limits.

Note: If data fields are omitted, they are set to GDN default values. The GDN limits can be retrieved via the GET /_api/tenant/{tenant} API.

put/_api/limits/defaults

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/limits/defaults/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

Example request

{
  "apiServer": {
    "maxRequestPerMinute": 60
  },
  "cep": {
    "maxPublishedWorkers": 30,
    "maxWorkersMemoryMB": 500,
    "maxMemoryMBPerWorker": 100,
    "maxWorkersCpuSecondsPerMinute": 60,
    "maxWorkersThroughputInMBPerMinute": 10,
    "maxWorkersThroughputOutMBPerMinute": 10,
    "maxLogsLengthKBPerMinutePerWorker": 10,
    "maxCpuSecondsPerMinutePerWorker": 20
  },
  "database": {
    "maxDocumentSize": 524288,
    "maxDocumentsReturnedByQuery": 1000,
    "maxQueryExecutionTimeInMs": 100000,
    "maxQueryMemoryBytes": 527958016,
    "maxGeoFabricsPerTenant": 2,
    "maxCollectionsPerFabric": 10,
    "maxGraphsPerFabric": 2,
    "maxIndexes": 10,
    "maxViewsPerFabric": 2,
    "maxRequestsPerDay": 20000,
    "maxStoragePerRegion": 412467200,
    "maxRestQLUsagePerFabric": 1000,
    "maxRestQLUsagePerDay": 1000,
    "maxDocumentsImportedPerAPICall": 10000
  },
  "streamsGlobal": {
    "maxStreamsCount": 25,
    "maxProducersCount": 14,
    "maxConsumersCount": 14,
    "maxSubscriptionsCount": 14,
    "maxBacklogMessageTTLMin": 240,
    "maxBacklogStorageSizeMB": 100,
    "maxDispatchThrottlingRateInByte": 4096
  },
  "streamsLocal": {
    "maxStreamsCount": 25,
    "maxProducersCount": 14,
    "maxConsumersCount": 14,
    "maxSubscriptionsCount": 14,
    "maxBacklogMessageTTLMin": 240,
    "maxBacklogStorageSizeMB": 100,
    "maxDispatchThrottlingRateInByte": 4096
  },
  "dataMeshIntegration": {
    "maxConnections": 100,
    "maxWorkflows": 1000
  }
}

Response

Successfully updated the default tenant limit.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

Example response

{
  "code": 200,
  "result": {
    "apiServer": {
      "maxRequestPerMinute": 60
    },
    "cep": {
      "maxPublishedWorkers": 30,
      "maxWorkersMemoryMB": 500,
      "maxMemoryMBPerWorker": 100,
      "maxWorkersCpuSecondsPerMinute": 60,
      "maxWorkersThroughputInMBPerMinute": 10,
      "maxWorkersThroughputOutMBPerMinute": 10,
      "maxLogsLengthKBPerMinutePerWorker": 10,
      "maxCpuSecondsPerMinutePerWorker": 20
    },
    "database": {
      "maxDocumentSize": 524288,
      "maxDocumentsReturnedByQuery": 1000,
      "maxQueryExecutionTimeInMs": 100000,
      "maxQueryMemoryBytes": 527958016,
      "maxGeoFabricsPerTenant": 2,
      "maxCollectionsPerFabric": 10,
      "maxGraphsPerFabric": 2,
      "maxIndexes": 10,
      "maxViewsPerFabric": 2,
      "maxRequestsPerDay": 20000,
      "maxStoragePerRegion": 412467200,
      "maxRestQLUsagePerFabric": 1000,
      "maxRestQLUsagePerDay": 1000,
      "maxDocumentsImportedPerAPICall": 10000
    },
    "streamsGlobal": {
      "maxStreamsCount": 25,
      "maxProducersCount": 14,
      "maxConsumersCount": 14,
      "maxSubscriptionsCount": 14,
      "maxBacklogMessageTTLMin": 240,
      "maxBacklogStorageSizeMB": 100,
      "maxDispatchThrottlingRateInByte": 4096
    },
    "streamsLocal": {
      "maxStreamsCount": 25,
      "maxProducersCount": 14,
      "maxConsumersCount": 14,
      "maxSubscriptionsCount": 14,
      "maxBacklogMessageTTLMin": 240,
      "maxBacklogStorageSizeMB": 100,
      "maxDispatchThrottlingRateInByte": 4096
    },
    "dataMeshIntegration": {
      "maxConnections": 100,
      "maxWorkflows": 1000
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.