Purpose

Retrieves limits that have been set at the system level.

URL

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

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,
     "value": limit_value
    },
    ...
  ]
}
Property Description Valid values
"id" The ID of the limit. A valid limit ID.
"value" The value of the system limit. An integer that meets the requirements of the minimum and maximum values for the limit.

Sample Server Success Response 

{
  "limits": [
    {
     "id": 1,
     "value": 500
    },
    {
     "id": 2,
      "value": 1800
    },
    {
     "id": 3,
     "value": 5
    },
    {
     "id": 4,
     "value": 3600
    },
    {
     "id": 6,
     "value": 1000
    },
    {
     "id": 8,
     "value": 60
    }
  ]
}

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.