Purpose

Retrieves configurable limits.

URL

https://<myserver>:<port>/api/admin/limits

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Response Definition

The response takes the following format.

{
  "limits": [
    {
      "id": limit_id,
      "name": "limit_name",
      "description": "limit_description",
      "minValue": min_value,
      "maxValue": max_value,
      "defaultValue": default_value,
      "validForLimits": integer
    },
    ...
  ]
}
Properties Description Valid values
"id" The ID of the limit. A valid limit ID.
"name" The name of the limit. A valid limit name.
"description" The description of the limit. The limit description.
"minValue" The minimum possible value of the limit. A valid minimum value.
"maxValue" The maximum possible value of the limit. A valid maximum value.
"defaultValue" The default value of the limit. The default value.
"validForLimits" A numeric value that indicates at what level or levels the limit can be set. 1 | 11 | 15

1 indicates the limit can only be set at the system level.

11 indicates the limit can be set at the system, tenant, and user levels, or a combination of these.

15 indicates the limit can be set at the system, tenant, user, and data source levels, or a combination of these.

Sample Server Success Response 


      Status code: 200
      Successful response
            
{
    "limits": [
        {
            "id": 1,
            "name": "MaxFetchRows",
            "description": "Maximum number of rows allowed to be fetched for a
single query",
            "minValue": 1,
            "maxValue": 9000000000000000000,
            "defaultValue": 9000000000000000000,
            "validForLimits": 15
        },
        {
            "id": 2,
            "name": "PasswordLockoutInterval",
            "description": "The duration, in seconds, for counting the number of
consecutive failed authentication attempts.",
            "minValue": 1,
            "maxValue": 1000000000,
            "defaultValue": 900,
            "validForLimits": 1
        },
        ...
        {
            "id": 5,
            "name": "CORSBehavior",
            "description": "Configuration parameter for CORS behavior.
Setting the value to 0 disables the CORS filter. Setting the value to 1
enables the CORS filter. Setting the value to 2 enables the CORS filter
with the whitelist option.",
            "minValue": 0,
            "maxValue": 2,
            "defaultValue": 0,
            "validForLimits": 1
        },
        {
            "id": 6,
            "name": "ODataMaxConcurrentPagingQueries",
            "description": "Maximum number of concurrent active queries per
data source",
            "minValue": 0,
            "maxValue": 9000000000000000000,
            "defaultValue": 0,
            "validForLimits": 15
        },
        {
            "id": 7,
            "name": "LogRetentionDays",
            "description": "Number of days log files should be retained",
            "minValue": 0,
            "maxValue": 9000000000000000000,
            "defaultValue": 30,
            "validForLimits": 1
        },
        {
            "id": 8,
            "name": "OAuthAccessTokenDuration",
            "description": "The duration, in minutes, for which a Access token
is valid.",
            "minValue": 1,
            "maxValue": 1440,
            "defaultValue": 60,
            "validForLimits": 1
        },
        ...
        {
            "id": 21,
            "name": "SQLStatementAuditing",
            "description": "Enable SQL statement execution auditing",
            "minValue": 0,
            "maxValue": 1,
            "defaultValue": 0,
            "validForLimits": 15
        },
        ...
    ]
}

Sample Server Failure Response 

{
  "error": {
    "code": 222207925,
    "message": {
      "lang": "en-US",
      "value": "Problem processing the limits at this time. Please try again at
another time.."
    }
  }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) or the Limits (27) permission.