The addLimit() GraphQL mutation is used to add a limit to a given organization.

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 addLimit() mutation field:

graphql
addLimit(
      input: AddLimitInput!
    ): boolean!

In the syntax above, you would replace AddLimitInput with arguments required or allowed by that input definition (see the AddLimitInput table below). A boolean value is always returned that your API client may capture and use.

Given Datatypes

For the input (i.e., AddLimitInput), there are several parameters that may be given. Below is a list of them along with their data type and a description of each:

Table: AddLimitInput

ParameterTypeRequired[a]DefaultDescription
limitNamestringyes The name of the limit to add.
allowLoginbooleanyes Whether the limit allows logging in.
dailyIngestlongyes The daily ingest allowed for the limit.
retentionintegeryes The retention in days allowed for the limit.
allowSelfServicebooleanyes Whether the limit allows self-service.
expirationlong  The expiration date for the limit.
contractVersionOrganizations__ContractVersion  The version of the contract, using the enumerate list of Organizations__ContractVersion: Unknown, Version1, or Version2.
userLimitinteger  The limit for users.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


One of these parameters uses Organizations__ContractVersion. This is just an enumerated list of choices: Unknown; Version1; or Version2.