Deployment Properties | ArcGIS REST APIs

URL:: https://<root>/system/deployments/properties
Methods:: GET
Child Resources:: Property Template
Version Introduced:: 10.9

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Default administrator role only

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

The properties resource returns the default template for GIS service microservices, as well as microservices that are not service related. The properties section for each template can be updated using the Edit (Default Properties) operation.

Starting at ArcGIS Enterprise 11.2 on Kubernetes, the default property template supports having node affinity and tolerations that are applied to the pods of newly created GIS service deployments.

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Response properties

Property	Details
`mode`	The microservice mode. A mode type of `Undefined` is returned when the microservice is system related (Admin API, portal sharing, ingress controller, and so on). Only microservices related to an ArcGIS service type return `Dedicated` or `Shared` for this property. Values: `Shared` \| `Dedicated` \| `Undefined` \| `Primary` \| `Standby` \| `Coordinator`
`provider`	The microservice provider. Only microservices related to an ArcGIS service type have a provider type. A provider type of `Undefined` is returned for microservices that are not service related (Admin API, portal sharing, ingress controller, and so on). Values: `SDS` \| `ArcObjects11` \| `DMaps` \| `Undefined` \| `Postgres` \| `Tiles` \| `Ignite` \| `MinIO` \| `Elasticsearch` \| `RabbitMQ` \| `ArcObjectsRasterRendering`
`id`	The template ID. Example Use dark colors for code blocksCopy `1 "id": "9375dd81-30d1-41c0-a802-cabb425159a9",`
`type`	The microservice type. For example, if the microservice is a shared feature server containing feature services, `FeatureServer` is returned. Values: `FeatureServer` \| `GeometryServer` \| `GPServer` \| `GPSyncServer` \| `MapServer` \| `TileServer` \| `System` \| `InMemoryStore` \| `ObjectStore` \| `SpatiotemporalIndexStore` \| `QueueServer` \| `RelationalStore` \| `WebhookProcessor` (Added at 11.0)
`spec`	The JSON object representation of the template's specifications, including replicas and the container resources. Example Use dark colors for code blocksCopy 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 "spec": { "replicas": { "min": 3, "max": 3, "scalingMode": "manual" //Added at 11.0 }, "podPlacementPolicy": { "tolerations": [ { "effect": "NoSchedule", "key": "label1", "operator": "Equal", "value": "test1" } ] "nodeAffinity": {} }, "containers": [ { "name": "main-container", "resources": { "memoryMin": "500Mi", "memoryMax": "4Gi", "cpuMin": "0.125", "cpuMax": "2" }, "containerImageKey": "SDS_FEATURE_SERVER" }, { "name": "filebeat", "resources": { "memoryMin": "32Mi", "memoryMax": "50Mi", "cpuMin": "0.05", "cpuMax": "0.25" }, "containerImageKey": "FILEBEAT" } ] }
`replicas`	The number of replicas for the microservice. For manual scaling, the value for both `min` and `max` must be the same. Organizations using a version of ArcGIS Enterprise on Kubernetes at 10.9.1 or higher have the option to enable autoscaling. For more information on manual scaling and autoscaling, see the Edit. Warning Though scaling properties can be updated using the Edit default properties and Edit deployment operations, to reduce risk of errors it is recommended that changes to scaling information is performed using the Edit scaling. Example Use dark colors for code blocksCopy `1 2 3 4 5 "replicas": { "min": 3, "max": 3, "scalingMode": "manual" //Added at 11.0 },`
`podPlacementPolicy`	Introduced at 11.2. The node affinity or tolerations applied to the pods of a GIS service deployment. For more information on node affinity and tolerations, see the Edit operation. Example Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 12 13 ... "podPlacementPolicy": { "tolerations": [ { "effect": "NoSchedule", "key": "label1", "operator": "Equal", "value": "test1" } ] "nodeAffinity": {} }, ...`
`resources`	The minimum and maximum resource allocations for the microservice, including the minimum memory (`memoryMin`) and minimum CPU (`cpuMin`) resources required for the microservice to start. The default values for `memoryMin`, `cpuMin`, `memoryMax`, and `cpuMax` are outlined in the example below. Starting at ArcGIS Enterprise 11.3 on Kubernetes, `resources` also includes the `customResources` object, which includes the values for GPU requests and limits for GPU nodes that are part of raster analytic and deep learning workflows. Example Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 12 13 14 "resources": { "memoryMin": "500Mi", "memoryMax": "2Gi", "cpuMin": "0.125", "cpuMax": "2", "customResources": { "limits": { "nvidia.com/gpu": "1" }, "requests": { "nvidia.com/gpu": "1" } } }`
`revision`	The date, in milliseconds from epoch format, of the latest revision to the template. Use dark colors for code blocksCopy `1 "revision": 1598217421474`

Example usage

The following is a sample request URL used to access the properties resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/system/deployments/properties?f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
  "properties": [
    {
      "mode": "Shared",
      "provider": "SDS",
      "id": "prava5pumwtr4a9tu4u6x",
      "type": "FeatureServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 10,
          "scalingMode": "auto",
          "autoscaling": {
            "hpaSpec": {
              "metrics": [
                {
                  "resource": {
                    "name": "cpu",
                    "target": {
                      "averageUtilization": "65",
                      "type": "Utilization"
                    }
                  },
                  "type": "Resource"
                }
              ],
              "hpaVersion": "autoscaling/v2"
            }
          }
        },
        "podPlacementPolicy": {
          "tolerations": [{"effect": "NoSchedule","key": "label1","operator": "Equal","value": "test1"}]
          "nodeAffinity": {}
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "SDS_FEATURE_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462610863
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pub3eotrxkkfwjq5mej0z",
      "type": "GPServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "1.5Gi",
              "memoryMax": "2Gi",
              "cpuMin": "0.125",
              "cpuMax": "1"
            },
            "containerImageKey": "GPPROXY_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462610897
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pykfh7b6tclxybgr4btz6",
      "type": "GPSyncServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "1.5Gi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "GP_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462610920
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pc6zcbz5dooa6a4rkw8vd",
      "type": "DistributedServer",
      "spec": {
        "replicas": {
          "min": 2,
          "max": 2,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "1.5Gi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "DISTRIBUTED_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462610937
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pice0u4obpd61q1468awv",
      "type": "MapServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "2Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "MAP_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462610954
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pkdgkvtk715depace6u12",
      "type": "GeometryServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "2Gi",
              "cpuMin": "0.125",
              "cpuMax": "1"
            },
            "containerImageKey": "GEOMETRY_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611029
    },
    {
      "mode": "Shared",
      "provider": "DMaps",
      "id": "pdidly9jaqnemz24fiand",
      "type": "MapServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "MAP_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611048
    },
    {
      "mode": "Shared",
      "provider": "Tiles",
      "id": "psnbuq4yo1mqbqa7iwm4s",
      "type": "TileServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "2Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "TILE_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611066
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pb1uozskr2pt5xohg8aqj",
      "type": "GeocodeServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "GEOCODE_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611084
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pjzgnwaihdcsk8ot939kk",
      "type": "ImageServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "IMAGE_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611103
    },
    {
      "mode": "Shared",
      "provider": "ArcObjectsRasterRendering",
      "id": "ps6lhh4esym49vqx13yni",
      "type": "ImageServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "IMAGE_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611121
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "id": "pc87bjte6yjihiajr111s",
      "type": "WebhookProcessor",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "0.5Gi",
              "memoryMax": "1Gi",
              "cpuMin": "0.25",
              "cpuMax": "0.5"
            },
            "containerImageKey": "WEBHOOK_PROCESSOR"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611138
    }
  ]
}