- URL:
- https://<root>/system/deployments
- Methods:
GET- Operations:
- Find Deployment IDs, Get Deployments by IDs
- Child Resources:
- Deployment Default Properties, Deployment
- 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.
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 generate 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.
Description
The deployments resource represents a list of all the microservices that are used to host or run an organization's services, as well as items that are not service related such as ArcGIS Enterprise Administrator API, portal sharing, and ingress controller microservices. Each microservice listed here may correspond to one or more pods in ArcGIS Enterprise on Kubernetes.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Response properties
| Property | Details |
|---|---|
| The microservice mode. A mode type of Values: |
| The microservice provider. Only microservices related to an ArcGIS service type have a provider type. A provider type of Values: |
| The unique microservice ID. |
| The microservice name. |
| The microservice type. For example, if the microservice is a shared feature server containing feature services, Values: |
Example usage
The following is a sample request URL used to access the deployments resource:
https://organization.example.com/<context>/admin/system/deployments?f=pjsonJSON Response example
{
"deployments": [
{
"mode": "Primary",
"provider": "Postgres",
"deploymentId": "kcl3kjxkzpqxvqyr3eq9k",
"name": "relational-store-primary",
"type": "RelationalStore"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kbcvh0xlvq7bz7hj2fdoe",
"name": "rest-administrator-api",
"type": "System"
},
{
"mode": "Undefined",
"provider": "Ignite",
"deploymentId": "khl7mqxvko7jgee19hzjz",
"name": "in-memory-store",
"type": "InMemoryStore"
},
{
"mode": "Undefined",
"provider": "RabbitMQ",
"deploymentId": "ksnb0ni1mlumiutbwt68c",
"name": "queue-store",
"type": "QueueServer"
},
{
"mode": "Coordinator",
"provider": "Elasticsearch",
"deploymentId": "klo264swsfex85k9mgs7a",
"name": "spatiotemporal-index-store-coordinator",
"type": "SpatiotemporalIndexStore"
},
{
"mode": "Undefined",
"provider": "Ozone",
"deploymentId": "kmk4d65z1mpij8dpuq8j2",
"name": "object-store",
"type": "ObjectStore"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kr4aa5hdmemz3px8gu0tl",
"name": "ingress-controller",
"type": "System"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "khutr6dpoxzeiy1nvxxu5",
"name": "enterprise-help",
"type": "System"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kmz9r82wjmmc63r7e74r7",
"name": "rest-metrics-api",
"type": "System"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "klewkicrcov249b2ci4b8",
"name": "metrics-viewer",
"type": "System"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kskhg3fcjub5yxwznot6d",
"name": "enterprise-web-style-app",
"type": "System"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kbts139il9t8g4apvsxro",
"name": "enterprise-apps",
"type": "System"
},
{
"mode": "Standby",
"provider": "Postgres",
"deploymentId": "kz2xu3ynp7wh2gvow5ohj",
"name": "relational-store-standby",
"type": "RelationalStore"
},
{
"mode": "Shared",
"provider": "DMaps",
"deploymentId": "ktt7hf4kkc25lp91v74l8",
"name": "shared-mapserver",
"type": "MapServer"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kyylv9fpgfkk8juuawc8c",
"name": "rest-portal-api",
"type": "System"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kt03u22ovosut0lgrxmrf",
"name": "featureserver-webhook-processor",
"type": "WebhookProcessor"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kla7ndpm08g6h0xazmpnn",
"name": "mapimagededicatedchrome-mapserver",
"type": "MapServer"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kfoxsf37skk57s8dcbt1q",
"name": "rest-services-api",
"type": "System"
},
{
"mode": "Shared",
"provider": "ArcObjectsRasterRendering",
"deploymentId": "kn2air4p2ipvanhu2983s",
"name": "shared-imageserver",
"type": "ImageServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "km2ihja7o5tee4ofrwd7u",
"name": "system-publishingtools-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "ko4g4ssxj2ncha7u64t19",
"name": "system-featureservicetools-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kjofq1mi2xrjsfa84hb87",
"name": "system-rasterprocessing-imageserver",
"type": "ImageServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kvderz4d68wmjgyj7ykds",
"name": "system-cachingcontrollers-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "ku2kda5mdm41gu7mybpsy",
"name": "system-publishingtools-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kh937gak4ai7fghgdb65v",
"name": "enterprise-portal",
"type": "System"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kg89hcdp2mvyyvrsgeugj",
"name": "javascript-api",
"type": "System"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kf01w2lnseqkcxkrerjt8",
"name": "system-cachingtools-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "ksy8inelmobv7lqt0uinw",
"name": "system-synctools-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kwrd1gl750v84pmtdeh9v",
"name": "system-featureservicetools-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kplo4zwtq0xak18i4dhwl",
"name": "system-synctools-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kks883gnrm3b39bvsuqp0",
"name": "system-rasteranalysistools-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kdmamqimnu4jq91ji5xgu",
"name": "system-rasteranalysistools-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kesvgxpzqlvk0310uta0t",
"name": "system-scenecachingcontrollers-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "karpadh1fxbm14240anqu",
"name": "system-spatialanalysistools-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kqwvef2spfswkez2puqvw",
"name": "system-scenecachingtools-gpserver",
"type": "GPServer"
},
{
"mode": "Shared",
"provider": "SDS",
"deploymentId": "kzimp431axh908gnk92rf",
"name": "shared-featureserver",
"type": "FeatureServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kyobqq503fyivz0z5gmyv",
"name": "system-scenecachingtools-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kmhzdq44lfnxlx9ykth8p",
"name": "utilities-geometry-geometryserver",
"type": "GeometryServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "krbjyp6shb898cq4e6uud",
"name": "system-scenecachingcontrollers-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kryd84xmbd2jzvn29c1ow",
"name": "mapimagededicatededge-mapserver",
"type": "MapServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kxo5hed4t6kpk4atykdr6",
"name": "utilities-geocodingtools-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kyfvzfn3vigdncj24ebcf",
"name": "utilities-printingtools-gpserver",
"type": "GPServer"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "ky3w45mll49ub66ebvjn0",
"name": "gpserver-webhook-processor",
"type": "WebhookProcessor"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "krmbt6zbwlwm1tsv5qk5z",
"name": "utilities-offlinepackaging-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kxryem20it0i8mgzfvdpy",
"name": "utilities-offlinepackaging-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "knyhxc03neyg5tu1b7usu",
"name": "sampleworldcities-mapserver",
"type": "MapServer"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kam914hkk97i4pq0sumoh",
"name": "enterprise-manager",
"type": "System"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kx4smzq2gsvtbr1pxc412",
"name": "private-ingress-controller",
"type": "System"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kig0fapa24yrhm42qaoew",
"name": "utilities-geocodingtools-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Undefined",
"provider": "Undefined",
"deploymentId": "kuzo3kh8u48ktyszr5ixy",
"name": "service-lifecycle-manager",
"type": "System"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kgy2s9ugr8k9tbu3uf5ky",
"name": "utilities-rasterutilities-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kf0iq5y4c4y1l28lf7twy",
"name": "system-reportingtools-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "ksojxx1po5lsnt585kfl6",
"name": "utilities-rasterutilities-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "khu68r4a7lrqealb03niy",
"name": "system-spatialanalysistools-gpsyncserver",
"type": "GPSyncServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "ksk6s2cmp1pyz2kqo5vlm",
"name": "system-cachingcontrollers-gpserver",
"type": "GPServer"
},
{
"mode": "Dedicated",
"provider": "ArcObjects11",
"deploymentId": "kqlgzq4yplem7d61s325r",
"name": "system-cachingtools-gpserver",
"type": "GPServer"
}
],
"supportedOperations": [
"properties",
"findDeployments"
]
}