- URL:
- https://<root>/system/properties
- Methods:
GET- Required Capability:
- Administrator
- Version Introduced:
- 12.2
Description
The properties resource is a container for ArcGIS Data Pipelines Server configuration properties that govern some of its behavior. The properties are applied to all server machines in the ArcGIS Data Pipelines Server site.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Server properties
| Property | Details |
|---|---|
| The number of workers that can be active simultaneously. Workers are the compute resources that are allocated to power the ArcGIS Data Pipelines editor, scheduled task runs, and stand-alone data pipeline runs. Example |
| The number of cores each worker can use. For example, if you process large amounts of data, you may need to increase this value in order for the runs to complete successfully. Example |
| The amount of memory each worker can use specified in megabytes. For example, if you process large amounts of data, you may need to increase this value in order for the runs to complete successfully. Example |
| The number of workers that are reserved for interactive authoring in the Data Pipelines editor. For example, if you have a single-machine ArcGIS Data Pipelines Server site, and Example |
| Specifies which hosts can be used to read in data when using the URL input. The default is none Example Example |
| Specifies which file share paths are accessible by the File share input. By default, all file shares that are accessible by the ArcGIS Data Pipelines Server account will be available for use in the File share input. Some directories are always restricted, including install directories and system managed or OS protected directories. Example To block access to all file shares, specify an empty list. Example |
Example usage
The following is a sample request URL used to access the properties resource:
https://organization.example.com/<context>/admin/system/properties?f=pjsonJSON Response syntax
{
"<property1>": <value1>,
"<property2>": <value1>,
...
}JSON Response example
{
"maxMemoryPerWorkerInMiB": 4096,
"maxCoresPerWorker": 2,
"allowedHosts": "(.*)",
"maxWorkersPerMachine": 6,
"reservedInteractiveWorkersPerMachine": 2
}