Skip To Content
ArcGIS Developers
Dashboard

Deployments

Description

This resource represents a list of all the microservices that are used to host or run your services, as well as non-service items such as the ArcGIS Enterprise Admin API, Portal Sharing, and ingress controller microservices. Each microservice listed here may correspond to one or more pods in ArcGIS Enterprise on Kubernetes. This resource provides access to the edit operation that sets scaling and resource allocations, as well as the find deployments operation that can be used to search and filter microservices.

Request parameters

ParameterDetails
f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails
mode

The microservice mode. A mode type of Undefined is returned when the microservice is system related (Admin API, Portal Sharing, ingress controller, etc.). Only microservices related to an ArcGIS service type will return either 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 will have a provider type. A provider type of Undefined is returned for non-service related microservices (Admin API, Portal Sharing, ingress controller, etc.)

Values: SDS | ArcObjects11 | DMaps | Undefined | Postgres | Tiles | Ignite | MinIO | Elasticsearch | RabbitMQ

deploymentId

The unique ID of the microservice.

name

The microservice name.

type

The microservice type. For example, if the microservice is a shared feature server containing feature services, the value returned will be FeatureServer. For non-service related microservices, the type will be listed as System.

Values: FeatureServer | GeometryServer | GPServer | GPSyncServer | MapServer | TileServer | System | InMemoryStore | ObjectStore | SpatiotemporalIndexStore | QueueServer | RelationalStore

Example usage

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

https://organization.domain.com/context/admin/system/deployments?f=pjson

JSON Response example

{
  "deployments": [
    {
      "mode": "Primary",
      "provider": "Postgres",
      "deploymentId": "ke84ls9uva6t7fvck8q5p",
      "name": "relational-store-primary",
      "type": "RelationalStore"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kvyxph9w5h3o9vgk8dixn",
      "name": "rest-administrator-api",
      "type": "System"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "ky6vk601p5ltq41sra837",
      "name": "ingress-controller",
      "type": "System"
    },
    {
      "mode": "Shared",
      "provider": "Tiles",
      "deploymentId": "kromfc1czgw32shdosf6o",
      "name": "shared-tileserver",
      "type": "TileServer"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kaboyg6l9210lqlud9fgf",
      "name": "enterprise-portal",
      "type": "System"
    },
    {
      "mode": "Undefined",
      "provider": "Ignite",
      "deploymentId": "ke61ffwin2s2hqt8hvagc",
      "name": "in-memory-store",
      "type": "InMemoryStore"
    },
    {
      "mode": "Undefined",
      "provider": "MinIO",
      "deploymentId": "kje0u66i1bysjkthxz6xo",
      "name": "object-store",
      "type": "ObjectStore"
    },
    {
      "mode": "Coordinator",
      "provider": "Elasticsearch",
      "deploymentId": "kayitio5sx2cf2jqfli7j",
      "name": "spatiotemporal-index-store-coordinator",
      "type": "SpatiotemporalIndexStore"
    },
    {
      "mode": "Undefined",
      "provider": "RabbitMQ",
      "deploymentId": "kmlaavr6ieiuii5g2lefw",
      "name": "queue-store",
      "type": "QueueServer"
    },
    {
      "mode": "Standby",
      "provider": "Postgres",
      "deploymentId": "ka3n63hm172qehb93h2h3",
      "name": "relational-store-standby",
      "type": "RelationalStore"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kxehn9vrxxzr5cqlivj5u",
      "name": "system-reportingtools-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kyn82ynxf02k1bdh6idmg",
      "name": "service-lifecycle-manager",
      "type": "System"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "ko107ljvs3nidbsgq7f83",
      "name": "system-synctools-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kqgyn2y4q641ashk758au",
      "name": "system-cachingtools-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kkofv97818b17uov4b9xg",
      "name": "system-cachingcontrollers-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kaflpb6nlpwo3rtb3nnka",
      "name": "system-reportingtools-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "km2i64zqhhs35dhx0wqca",
      "name": "system-publishingtools-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kvb62a2wiow4jj4u58hqx",
      "name": "system-cachingcontrollers-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "ks251s7g8r0m6u2899c71",
      "name": "system-scenecachingtools-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kwaqahojoi0btqjzddnrs",
      "name": "system-scenecachingtools-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "ktfaz5d7imjq0xmkqnxt7",
      "name": "system-scenecachingcontrollers-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kwufjydfc85w12svqxzsg",
      "name": "utilities-geocodingtools-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kiwj8zin8bqsv8psu0xor",
      "name": "utilities-offlinepackaging-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kvq83gt2vrtd50vsv0xvf",
      "name": "utilities-offlinepackaging-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kt6g04gycjmwehdubcugq",
      "name": "utilities-printingtools-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kfvj4tic5kej1s3sl4vpg",
      "name": "sampleworldcities-mapserver",
      "type": "MapServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "ka0z54mmgdngs6xes7be5",
      "name": "utilities-geocodingtools-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "ks8ioaj6zutd1l1duwpi9",
      "name": "utilities-printingtools-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kz1xijcfepnf76ljjvrmu",
      "name": "enterprise-help",
      "type": "System"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "krm8ymbe5dzj0u0r753ot",
      "name": "enterprise-manager",
      "type": "System"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kaawsx9zbuhp2do1jgl4j",
      "name": "rest-portal-api",
      "type": "System"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kyeh59c8uir5hdzinwh79",
      "name": "rest-services-api",
      "type": "System"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kqvn65pmkfhoih4un3d8d",
      "name": "private-ingress-controller",
      "type": "System"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kok7a6u1z8e03rba8onkh",
      "name": "rest-metrics-api",
      "type": "System"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kcefjj00etcsa5l5aru8c",
      "name": "metrics-viewer",
      "type": "System"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kjdlpyf4299dmw2dzt4fj",
      "name": "javascript-api",
      "type": "System"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "ki01yxm9htq2yzqa20st1",
      "name": "utilities-geometry-geometryserver",
      "type": "GeometryServer"
    },
    {
      "mode": "Shared",
      "provider": "SDS",
      "deploymentId": "kac2xpz64tbp61m9d5bw8",
      "name": "shared-featureserver",
      "type": "FeatureServer"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "kfsyxqo3p87zc8h2vdkbn",
      "name": "enterprise-web-style-app",
      "type": "System"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kso3vys7531gnu6vfa1yj",
      "name": "system-scenecachingcontrollers-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kghnth53z024xssx64345",
      "name": "system-cachingtools-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "deploymentId": "krok4sy0m3ygbvuv82lhi",
      "name": "enterprise-apps",
      "type": "System"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kvrzqj6xzrmw1zn60qo26",
      "name": "system-featureservicetools-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kkfm9k5gz7sl3bcpcparp",
      "name": "system-featureservicetools-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Shared",
      "provider": "DMaps",
      "deploymentId": "kvymoiqt0cl52ldoma1fh",
      "name": "shared-mapserver",
      "type": "MapServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "ky40l6d4qw84ibb0kpmkb",
      "name": "system-publishingtools-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kv5isihvwgzcl1le5jkwh",
      "name": "system-spatialanalysistools-gpserver",
      "type": "GPServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "koeeaxihuk68ysprnzl1s",
      "name": "system-synctools-gpsyncserver",
      "type": "GPSyncServer"
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "deploymentId": "kgd53k8blcl3gpbjspgu1",
      "name": "system-spatialanalysistools-gpsyncserver",
      "type": "GPSyncServer"
    }
  ],
  "supportedOperations": [
    "properties",
    "findDeployments"
  ]
}