Quotas
Use the endpoints described below to manage resource quotas. Quotas provide limits on resource consumption for deployments, models, and other DataRobot resources to ensure fair usage and prevent resource exhaustion.
Retrieve Quota Templates
Operation path: GET /api/v2/quotaTemplates/
Authentication requirements: BearerAuth
Parameters
| Name |
In |
Type |
Required |
Description |
| offset |
query |
integer |
true |
This many results will be skipped |
| limit |
query |
integer |
true |
At most this many results are returned |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of quota templates",
"items": {
"properties": {
"id": {
"description": "Unique identifier for the quota template",
"type": "string"
},
"name": {
"description": "Name of the quota template",
"type": "string"
},
"rules": {
"description": "List of quota rules in this template",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"id",
"name",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.39"
}
Responses
Retrieve Quota Templates by quota template ID
Operation path: GET /api/v2/quotaTemplates/{quotaTemplateId}/
Authentication requirements: BearerAuth
Parameters
| Name |
In |
Type |
Required |
Description |
| quotaTemplateId |
path |
string |
true |
Specific quota template ID |
Example responses
200 Response
{
"properties": {
"id": {
"description": "Unique identifier for the quota template",
"type": "string"
},
"name": {
"description": "Name of the quota template",
"type": "string"
},
"rules": {
"description": "List of quota rules in this template",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"id",
"name",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
}
Responses
Retrieve Quotas
Operation path: GET /api/v2/quotas/
Authentication requirements: BearerAuth
Parameters
| Name |
In |
Type |
Required |
Description |
| resourceId |
query |
string |
false |
Resource ID for which quota is configured |
| resourceType |
query |
string |
false |
Resource Type for which quota is configured |
| offset |
query |
integer |
true |
This many results will be skipped |
| limit |
query |
integer |
true |
At most this many results are returned |
Example responses
200 Response
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of quotas",
"items": {
"properties": {
"capacity": {
"description": "Resource capacity",
"properties": {
"capacity": {
"description": "Capacity value",
"minimum": 0,
"type": "integer"
},
"units": {
"description": "Capacity type",
"enum": [
"requests",
"token"
],
"type": "string"
}
},
"required": [
"capacity",
"units"
],
"type": "object",
"x-versionadded": "v2.42"
},
"defaultRules": {
"description": "List of default quota rules",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
},
"id": {
"description": "Unique identifier for the quota",
"type": "string"
},
"policies": {
"description": "List of quota policies to overwrite quota per specific consumer",
"items": {
"properties": {
"consumerId": {
"description": "ID of the consumer",
"type": "string"
},
"consumerName": {
"description": "Consumer name",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"consumerType": {
"description": "Type of consumer",
"enum": [
"deployment",
"user",
"usergroup"
],
"type": "string"
},
"reserved": {
"description": "Reserved resource percentage",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"rules": {
"description": "List of quota rules for this policy",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"consumerId",
"consumerType",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 10000,
"type": "array"
},
"resourceId": {
"description": "ID of the specific resource",
"type": "string"
},
"resourceType": {
"description": "Type of resource the quota applies to",
"enum": [
"deployment"
],
"type": "string"
},
"saturationThreshold": {
"description": "Saturation threshold to enable guaranteed quotas",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"userId": {
"description": "ID of the user associated with the quota",
"type": "string"
}
},
"required": [
"defaultRules",
"id",
"policies",
"resourceId",
"resourceType",
"userId"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 10000,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.39"
}
Responses
Delete Quotas by quota ID
Operation path: DELETE /api/v2/quotas/{quotaId}/
Authentication requirements: BearerAuth
Parameters
| Name |
In |
Type |
Required |
Description |
| quotaId |
path |
string |
true |
Specific quota ID |
Responses
| Status |
Meaning |
Description |
Schema |
| 200 |
OK |
none |
None |
| 204 |
No Content |
The quota has been deleted. |
None |
Retrieve Quotas by quota ID
Operation path: GET /api/v2/quotas/{quotaId}/
Authentication requirements: BearerAuth
Parameters
| Name |
In |
Type |
Required |
Description |
| quotaId |
path |
string |
true |
Specific quota ID |
Example responses
200 Response
{
"properties": {
"capacity": {
"description": "Resource capacity",
"properties": {
"capacity": {
"description": "Capacity value",
"minimum": 0,
"type": "integer"
},
"units": {
"description": "Capacity type",
"enum": [
"requests",
"token"
],
"type": "string"
}
},
"required": [
"capacity",
"units"
],
"type": "object",
"x-versionadded": "v2.42"
},
"defaultRules": {
"description": "List of default quota rules",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
},
"id": {
"description": "Unique identifier for the quota",
"type": "string"
},
"policies": {
"description": "List of quota policies to overwrite quota per specific consumer",
"items": {
"properties": {
"consumerId": {
"description": "ID of the consumer",
"type": "string"
},
"consumerName": {
"description": "Consumer name",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"consumerType": {
"description": "Type of consumer",
"enum": [
"deployment",
"user",
"usergroup"
],
"type": "string"
},
"reserved": {
"description": "Reserved resource percentage",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"rules": {
"description": "List of quota rules for this policy",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"consumerId",
"consumerType",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 10000,
"type": "array"
},
"resourceId": {
"description": "ID of the specific resource",
"type": "string"
},
"resourceType": {
"description": "Type of resource the quota applies to",
"enum": [
"deployment"
],
"type": "string"
},
"saturationThreshold": {
"description": "Saturation threshold to enable guaranteed quotas",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"userId": {
"description": "ID of the user associated with the quota",
"type": "string"
}
},
"required": [
"defaultRules",
"id",
"policies",
"resourceId",
"resourceType",
"userId"
],
"type": "object",
"x-versionadded": "v2.39"
}
Responses
Modify Quotas by quota ID
Operation path: PATCH /api/v2/quotas/{quotaId}/
Authentication requirements: BearerAuth
Body parameter
{
"properties": {
"capacity": {
"description": "Resource capacity",
"properties": {
"capacity": {
"description": "Capacity value",
"minimum": 0,
"type": "integer"
},
"units": {
"description": "Capacity type",
"enum": [
"requests",
"token"
],
"type": "string"
}
},
"required": [
"capacity",
"units"
],
"type": "object",
"x-versionadded": "v2.42"
},
"defaultRules": {
"description": "List of default quota rules",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
},
"policies": {
"description": "List of quota policies to overwrite quota per specific consumer",
"items": {
"properties": {
"consumerId": {
"description": "ID of the consumer",
"type": "string"
},
"consumerName": {
"description": "Consumer name",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"consumerType": {
"description": "Type of consumer",
"enum": [
"deployment",
"user",
"usergroup"
],
"type": "string"
},
"reserved": {
"description": "Reserved resource percentage",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"rules": {
"description": "List of quota rules for this policy",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"consumerId",
"consumerType",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 10000,
"type": "array"
},
"saturationThreshold": {
"description": "Saturation threshold",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
}
},
"type": "object",
"x-versionadded": "v2.39"
}
Parameters
| Name |
In |
Type |
Required |
Description |
| quotaId |
path |
string |
true |
Specific quota ID |
| body |
body |
QuotaUpdate |
false |
none |
Example responses
200 Response
{
"properties": {
"capacity": {
"description": "Resource capacity",
"properties": {
"capacity": {
"description": "Capacity value",
"minimum": 0,
"type": "integer"
},
"units": {
"description": "Capacity type",
"enum": [
"requests",
"token"
],
"type": "string"
}
},
"required": [
"capacity",
"units"
],
"type": "object",
"x-versionadded": "v2.42"
},
"defaultRules": {
"description": "List of default quota rules",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
},
"id": {
"description": "Unique identifier for the quota",
"type": "string"
},
"policies": {
"description": "List of quota policies to overwrite quota per specific consumer",
"items": {
"properties": {
"consumerId": {
"description": "ID of the consumer",
"type": "string"
},
"consumerName": {
"description": "Consumer name",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"consumerType": {
"description": "Type of consumer",
"enum": [
"deployment",
"user",
"usergroup"
],
"type": "string"
},
"reserved": {
"description": "Reserved resource percentage",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"rules": {
"description": "List of quota rules for this policy",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"consumerId",
"consumerType",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 10000,
"type": "array"
},
"resourceId": {
"description": "ID of the specific resource",
"type": "string"
},
"resourceType": {
"description": "Type of resource the quota applies to",
"enum": [
"deployment"
],
"type": "string"
},
"saturationThreshold": {
"description": "Saturation threshold to enable guaranteed quotas",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"userId": {
"description": "ID of the user associated with the quota",
"type": "string"
}
},
"required": [
"defaultRules",
"id",
"policies",
"resourceId",
"resourceType",
"userId"
],
"type": "object",
"x-versionadded": "v2.39"
}
Responses
Schemas
QuotaCapacity
{
"description": "Resource capacity",
"properties": {
"capacity": {
"description": "Capacity value",
"minimum": 0,
"type": "integer"
},
"units": {
"description": "Capacity type",
"enum": [
"requests",
"token"
],
"type": "string"
}
},
"required": [
"capacity",
"units"
],
"type": "object",
"x-versionadded": "v2.42"
}
Resource capacity
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| capacity |
integer |
true |
minimum: 0
|
Capacity value |
| units |
string |
true |
|
Capacity type |
Enumerated Values
| Property |
Value |
| units |
[requests, token] |
QuotaListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of quotas",
"items": {
"properties": {
"capacity": {
"description": "Resource capacity",
"properties": {
"capacity": {
"description": "Capacity value",
"minimum": 0,
"type": "integer"
},
"units": {
"description": "Capacity type",
"enum": [
"requests",
"token"
],
"type": "string"
}
},
"required": [
"capacity",
"units"
],
"type": "object",
"x-versionadded": "v2.42"
},
"defaultRules": {
"description": "List of default quota rules",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
},
"id": {
"description": "Unique identifier for the quota",
"type": "string"
},
"policies": {
"description": "List of quota policies to overwrite quota per specific consumer",
"items": {
"properties": {
"consumerId": {
"description": "ID of the consumer",
"type": "string"
},
"consumerName": {
"description": "Consumer name",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"consumerType": {
"description": "Type of consumer",
"enum": [
"deployment",
"user",
"usergroup"
],
"type": "string"
},
"reserved": {
"description": "Reserved resource percentage",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"rules": {
"description": "List of quota rules for this policy",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"consumerId",
"consumerType",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 10000,
"type": "array"
},
"resourceId": {
"description": "ID of the specific resource",
"type": "string"
},
"resourceType": {
"description": "Type of resource the quota applies to",
"enum": [
"deployment"
],
"type": "string"
},
"saturationThreshold": {
"description": "Saturation threshold to enable guaranteed quotas",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"userId": {
"description": "ID of the user associated with the quota",
"type": "string"
}
},
"required": [
"defaultRules",
"id",
"policies",
"resourceId",
"resourceType",
"userId"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 10000,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.39"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[QuotaResponse] |
true |
maxItems: 10000
|
List of quotas |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
QuotaPolicy
{
"properties": {
"consumerId": {
"description": "ID of the consumer",
"type": "string"
},
"consumerName": {
"description": "Consumer name",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"consumerType": {
"description": "Type of consumer",
"enum": [
"deployment",
"user",
"usergroup"
],
"type": "string"
},
"reserved": {
"description": "Reserved resource percentage",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"rules": {
"description": "List of quota rules for this policy",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"consumerId",
"consumerType",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| consumerId |
string |
true |
|
ID of the consumer |
| consumerName |
string,null |
false |
|
Consumer name |
| consumerType |
string |
true |
|
Type of consumer |
| reserved |
number,null |
false |
maximum: 1
minimum: 0
|
Reserved resource percentage |
| rules |
[QuotaRule] |
true |
maxItems: 100
|
List of quota rules for this policy |
Enumerated Values
| Property |
Value |
| consumerType |
[deployment, user, usergroup] |
QuotaResponse
{
"properties": {
"capacity": {
"description": "Resource capacity",
"properties": {
"capacity": {
"description": "Capacity value",
"minimum": 0,
"type": "integer"
},
"units": {
"description": "Capacity type",
"enum": [
"requests",
"token"
],
"type": "string"
}
},
"required": [
"capacity",
"units"
],
"type": "object",
"x-versionadded": "v2.42"
},
"defaultRules": {
"description": "List of default quota rules",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
},
"id": {
"description": "Unique identifier for the quota",
"type": "string"
},
"policies": {
"description": "List of quota policies to overwrite quota per specific consumer",
"items": {
"properties": {
"consumerId": {
"description": "ID of the consumer",
"type": "string"
},
"consumerName": {
"description": "Consumer name",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"consumerType": {
"description": "Type of consumer",
"enum": [
"deployment",
"user",
"usergroup"
],
"type": "string"
},
"reserved": {
"description": "Reserved resource percentage",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"rules": {
"description": "List of quota rules for this policy",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"consumerId",
"consumerType",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 10000,
"type": "array"
},
"resourceId": {
"description": "ID of the specific resource",
"type": "string"
},
"resourceType": {
"description": "Type of resource the quota applies to",
"enum": [
"deployment"
],
"type": "string"
},
"saturationThreshold": {
"description": "Saturation threshold to enable guaranteed quotas",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"userId": {
"description": "ID of the user associated with the quota",
"type": "string"
}
},
"required": [
"defaultRules",
"id",
"policies",
"resourceId",
"resourceType",
"userId"
],
"type": "object",
"x-versionadded": "v2.39"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| capacity |
QuotaCapacity |
false |
|
Resource capacity |
| defaultRules |
[QuotaRule] |
true |
maxItems: 100
|
List of default quota rules |
| id |
string |
true |
|
Unique identifier for the quota |
| policies |
[QuotaPolicy] |
true |
maxItems: 10000
|
List of quota policies to overwrite quota per specific consumer |
| resourceId |
string |
true |
|
ID of the specific resource |
| resourceType |
string |
true |
|
Type of resource the quota applies to |
| saturationThreshold |
number,null |
false |
maximum: 1
minimum: 0
|
Saturation threshold to enable guaranteed quotas |
| userId |
string |
true |
|
ID of the user associated with the quota |
Enumerated Values
| Property |
Value |
| resourceType |
deployment |
QuotaRule
{
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| limit |
integer |
true |
minimum: 0
|
Maximum limit for the quota rule |
| rule |
string |
true |
|
Type of quota rule |
| window |
string |
false |
|
Time window for the quota |
Enumerated Values
| Property |
Value |
| rule |
[concurrentRequests, inputSequenceLength, requests, token] |
| window |
[day, hour, min] |
QuotaTemplateListResponse
{
"properties": {
"count": {
"description": "The number of items returned on this page.",
"type": "integer"
},
"data": {
"description": "List of quota templates",
"items": {
"properties": {
"id": {
"description": "Unique identifier for the quota template",
"type": "string"
},
"name": {
"description": "Name of the quota template",
"type": "string"
},
"rules": {
"description": "List of quota rules in this template",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"id",
"name",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
},
"next": {
"description": "The URL of the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"previous": {
"description": "The URL of the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object",
"x-versionadded": "v2.39"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| count |
integer |
false |
|
The number of items returned on this page. |
| data |
[QuotaTemplateResponse] |
true |
maxItems: 100
|
List of quota templates |
| next |
string,null(uri) |
true |
|
The URL of the next page (if null, there is no next page). |
| previous |
string,null(uri) |
true |
|
The URL of the previous page (if null, there is no previous page). |
| totalCount |
integer |
true |
|
The total number of items across all pages. |
QuotaTemplateResponse
{
"properties": {
"id": {
"description": "Unique identifier for the quota template",
"type": "string"
},
"name": {
"description": "Name of the quota template",
"type": "string"
},
"rules": {
"description": "List of quota rules in this template",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"id",
"name",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| id |
string |
true |
|
Unique identifier for the quota template |
| name |
string |
true |
|
Name of the quota template |
| rules |
[QuotaRule] |
true |
maxItems: 100
|
List of quota rules in this template |
QuotaUpdate
{
"properties": {
"capacity": {
"description": "Resource capacity",
"properties": {
"capacity": {
"description": "Capacity value",
"minimum": 0,
"type": "integer"
},
"units": {
"description": "Capacity type",
"enum": [
"requests",
"token"
],
"type": "string"
}
},
"required": [
"capacity",
"units"
],
"type": "object",
"x-versionadded": "v2.42"
},
"defaultRules": {
"description": "List of default quota rules",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
},
"policies": {
"description": "List of quota policies to overwrite quota per specific consumer",
"items": {
"properties": {
"consumerId": {
"description": "ID of the consumer",
"type": "string"
},
"consumerName": {
"description": "Consumer name",
"type": [
"string",
"null"
],
"x-versionadded": "v2.39"
},
"consumerType": {
"description": "Type of consumer",
"enum": [
"deployment",
"user",
"usergroup"
],
"type": "string"
},
"reserved": {
"description": "Reserved resource percentage",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
},
"rules": {
"description": "List of quota rules for this policy",
"items": {
"properties": {
"limit": {
"description": "Maximum limit for the quota rule",
"minimum": 0,
"type": "integer"
},
"rule": {
"description": "Type of quota rule",
"enum": [
"concurrentRequests",
"inputSequenceLength",
"requests",
"token"
],
"type": "string"
},
"window": {
"default": "min",
"description": "Time window for the quota",
"enum": [
"day",
"hour",
"min"
],
"type": "string"
}
},
"required": [
"limit",
"rule"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 100,
"type": "array"
}
},
"required": [
"consumerId",
"consumerType",
"rules"
],
"type": "object",
"x-versionadded": "v2.39"
},
"maxItems": 10000,
"type": "array"
},
"saturationThreshold": {
"description": "Saturation threshold",
"maximum": 1,
"minimum": 0,
"type": [
"number",
"null"
],
"x-versionadded": "v2.42"
}
},
"type": "object",
"x-versionadded": "v2.39"
}
Properties
| Name |
Type |
Required |
Restrictions |
Description |
| capacity |
QuotaCapacity |
false |
|
Resource capacity |
| defaultRules |
[QuotaRule] |
false |
maxItems: 100
|
List of default quota rules |
| policies |
[QuotaPolicy] |
false |
maxItems: 10000
|
List of quota policies to overwrite quota per specific consumer |
| saturationThreshold |
number,null |
false |
maximum: 1
minimum: 0
|
Saturation threshold |