API Stability |
Long-Term
|
The updateLimitV2() GraphQL mutation is used to update the limit with the given name. Only the arguments defined will be updated.
For more information on query quotas, see the Query Quotas documentation page. You may also want to look at Limits & Standards for related information.
Syntax
Below is the syntax for the updateLimitV2() mutation field:
updateLimitV2(
input: UpdateLimitInputV2!
): LimitV2!
Below is an example of how this mutation field might be used:
mutation {
updateLimitV2( input:
{ id: "abc123",
userLimit: 10
}
)
{ id }
}
{
"data": {
"updateLimitV2": {
"id": "abc123"
}
}
}
Given Datatypes
For UpdateLimitInputV2, there are several parameters. Below is a list of them along with a description of each:
Table: UpdateLimitInputV2
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
Table last updated: Sep 23, 2024 | |||||
allowFlightControl | boolean | Whether to allow Flight control. | |||
allowLogin | boolean | Whether to allow login. | |||
allowSelfService | string | Whether to allow self service. | |||
dailyIngest | long | The amount of daily ingest allowed. | |||
dailyIngestContractualType | Organizations__ContractualType | The contractual type for daily ingest: Limited, Unlimited, or Ignored. | |||
dailyScan | long | The amount of daily scan permitted. | |||
dailyScanContractualType | Organizations__ContractualType | The contractual type for daily scans: Limited, Unlimited, or Ignored. | |||
dateType | string | The data type. | |||
expiration | long | The expiration date. | |||
id | string | yes | The unique identifier of the limit. | ||
maxRetention | integer | The maximum retention of events. | |||
measurementType | Organizations__MeasurementType | The type of measurement: SegmentWriteSize or ProcessedEventsSize. | |||
name | string | The name of the limit. | |||
repositoryLimit | integer | The limit for the repository. | |||
retention | integer | The amount of retention. | |||
storageContractualType | Organizations__ContractualType | The contractual type for storage: Limited, Unlimited, or Ignored. | |||
trial | boolean | Whether this is a trial limit. | |||
userLimit | integer | The user limit. |
Returned Datatypes
For LimitV2, there are several parameters. Below is a list of them along with a description of each:
Table: LimitV2
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
Table last updated: Mar 26, 2025 | |||||
allowFlightControl | boolean | yes | Long-Term | Whether the customer is allowed flight control. | |
allowLogin | boolean | yes | Long-Term | Whether the limit allows logging in. | |
allowSelfService | boolean | yes | Long-Term | Whether the limit allows self service. | |
dailyIngest | contractual | yes | Long-Term | The daily ingest allowed for the limit. | |
dataScannedLimit | contractual | yes | Long-Term | The data scanned measurement allowed for the limit. See Limited . | |
dataType | string | yes | Long-Term | Data type for the limit, all repositories linked to the limit will get this datatype logged in usage. | |
deletedDate | long | Long-Term | The deleted date for the limit. | ||
expirationDate | long | Long-Term | The expiration date for the limit. | ||
id | string | yes | Long-Term | The unique identifier of the limit. | |
limitName | string | yes | Long-Term | The name of the limit. | |
maxRetention | integer | yes | Long-Term | The max retention in days allowed for the limit, this can be greater than or equal to retention. | |
measurementPoint | Organizations__MeasurementType | yes | Long-Term | The usage measurement type used for the limit. This datatype is an enumerated list. The choices are SegmentWriteSize and ProcessedEventsSize . | |
repoLimit | integer | Long-Term | The number of repositories allowed for the limit. | ||
repositories | [Repository ] | yes | Long-Term | The repositories related to the limit. See Repository . | |
retention | integer | yes | Long-Term | The retention in days allowed for the limit, that's the contracted value. | |
storageLimit | contractual | yes | Long-Term | The amount of storage allowed for the limit. See Limited . | |
trial | boolean | yes | Long-Term | Whether the limit is a trial. | |
userLimit | contractual | yes | Long-Term | The user seats allowed for the limit. See Limited . |