Default Properties | ArcGIS REST APIs

URL:: https://<root>/system/deployments/properties/<propertyTemplateID>
Methods:: GET
Operations:: Edit
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

An individual microservice property template resource returns the default property template, which defines the default scaling and resource allocations for a specific microservice. The default property configuration is applied to microservices that match the type, provider, and mode values of the corresponding template. The default properties of a microservice can be updated using the Edit.

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 `NA` 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 `NA` is returned for microservices that are not service related (Admin API, portal sharing, ingress controller, and so on). Values: `SDS` \| `ArcObjects11` \| `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. For microservices that are not service related, `System` is returned. Values: `FeatureServer` \| `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 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 "spec": { "replicas": { "min": 3, "max": 3, "scalingMode": "manual" //Added at 11.0 }, "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 ArcGIS Enterprise on Kubernetes 10.9.1 or later can enable autoscaling. For more information about manual scaling and autoscaling, see the Edit scaling operation. 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 sacling operation. Example Use dark colors for code blocksCopy `1 2 3 4 5 "replicas": { "min": 3, "max": 3, "scalingMode": "manual" //Added at 11.0 },`
`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. 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": "32Mi", "memoryMax": "50Mi", "cpuMin": "0.05", "cpuMax": "0.25", "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. Example Use dark colors for code blocksCopy `1 "revision": 1598217421474`

Example usage

The following is a sample request URL used to access an individual microservice property template resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/system/deployments/properties/11abdae1-e44a-422c-911a-e8282dadf74a?f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
  "mode": "Dedicated",
  "provider": "ArcObjects11",
  "id": "pfnpl9gr7gi44g1ufg3h9",
  "type": "MapServer",
  "spec": {
    "replicas": {
      "min": 3,
      "max": 3,
      "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": 1618223886572
}