Update (Limits)

URL:
https://<root>/system/limits/update
Methods:
POST
Required Capability:
Access allowed with either the "Security and Infrastructure" or "Organization Website" privileges
Version Introduced:
11.2

Description

The update operation updates one or more limits (such as scheduled tasks for ArcGIS Notebook, Workflow Manager, ArcGIS Insights, and geoprocessing service tasks) at an individual user level or for the organization as a whole.

Request parameters

ParameterDetails

properties

A JSON array of limits to be updated. Only limits included in the request will be updated.

Syntax
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
properties={
  [
    {
      "limitName": "UpdateInsightsOrgLimit",
      "numLimit": <number>
    },
    {
      "limitName": "ExecuteNotebooksUserLimit",
      "numLimit": <number>
    },
    {
      "limitName": "ExecuteNotebooksOrgLimit",
      "numLimit": <number>
    },
    {
      "limitName": "ExecuteWorkflowManagerUserLimit",
      "numLimit": <number>
    },
    {
      "limitName": "ExecuteWorkflowManagerOrgLimit",
      "numLimit": <number>
    },
    {
      "limitName": "GPServiceUserLimit",
      "numLimit": <number>
    },
    {
      "limitName": "GPServiceOrgLimit",
      "numLimit": <number>
    },
    {
      "limitName": "FailedRunsToDisableTask",
      "numLimit": <number>
    },
    {
      "limitName": "TaskRunHistoryCount",
      "numLimit": <number>
    }
  ]
}
Example
1
2
3
4
5
6
7
8
9
10
properties=[
  {
    "limitName": "ExecuteNotebooksUserLimit",
    "numLimit": 15
  },
  {
    "limitName": "ExecuteNotebooksOrgLimit",
    "numLimit": 45
  }
]

category

The category of limits that will be updated. Currently, the only supported category is ScheduleTask.

f

The response format. The default response format is html.

Values: html | json | pjson

Limits

LimitsDetails

UpdateInsightsUserLimit

The maximum number of scheduled Insight reports that can be created by an individual user.

UpdateInsightsOrgLimit

The maximum total number of scheduled Insight reports for an organization.

ExecuteNotebooksUserLimit

The maximum number of active scheduled notebook tasks that can be owned by an individual user. By default, a user can only own 20 active notebooks tasks. When this limit is reached, the user will not be able to create a new notebook task until one of the notebook tasks change its status from Active to Complete, Failed, or Inactive.

ExecuteNotebooksOrgLimit

The maximum number of total active scheduled notebook tasks for an organization. By default, an organization is limited to 200 active notebook tasks. When this limit is reached, users will not be able to create any additional notebook tasks.

ExecuteWorkflowManagerUserLimit

The maximum number of scheduled recurring workflow manager jobs that can be created by an individual user.

ExecuteWorkflowManagerOrgLimit

The maximum total number of scheduled recurring workflow manager jobs for an organization.

FailedRunsToDisableTask

The number of times a task can fail consecutively before it is switched to a failed state. By default, a task can fail 5 times. When this limit is met, the task is changed from its active state, and the task owner must identify and rectify the issue before switching the task's access back to Active.

TaskRunHistoryCount

The total number of runs that are reported and maintained for a scheduled task. By default, only the 30 most recent runs will be maintained. Any tasks that are not within the most recent 30 runs will be permanetly deleted. The number of runs can be increased to a total of 50 runs per scheduled task.

GPServiceUserLimit

The maximum number of active scheduled geoprocessing service tasks that can be owned by an individual user.

GPServiceOrgLimit

The maximum total number of active scheduled geoprocessing service tasks for an organization.

Example usage

The following is a sample POST request for the update operation that demonstrates how to update ExecuteNotebooksUserLimit and ExecuteNotebooksOrgLimit:

1
2
3
4
5
6
POST /webadaptor/portaladmin/system/limits/update HTTP/1.1
Host: machine.domain.com
Content-Type:
Content-Length: [ ]

properties=[{"limitName": "ExecuteNotebooksUserLimit","numLimit": 15},{"limitName": "ExecuteNotebooksOrgLimit","numLimit": 45}]&category=ScheduleTask&f=pjson

JSON Response example

1
2
3
{
  "status": "success"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close