Get Deployments by ID | ArcGIS REST APIs

URL:: https://<root>/system/deployments/getDeploymentsById
Methods:: POST
Version Introduced:: 11.0

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.

Security and infrastructure

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 getDeploymentsById operation returns a list of microservices corresponding to the IDs included in the request.

Request parameters

Parameter Details

Parameter	Details
`deploymentIDs` (Required)	Filters deployments by their specific IDs. Deployment IDs can be gathered using the Find Deployment IDs operation. If you are including multiple IDs, each ID must be separated by a comma. Use dark colors for code blocksCopy `1 deploymentIDs=klor1w3y00uqay7gkop17,kxfmz19qfoks0gk9xmjok`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

deploymentIDs

(Required)

Filters deployments by their specific IDs. Deployment IDs can be gathered using the Find Deployment IDs operation. If you are including multiple IDs, each ID must be separated by a comma.

Use dark colors for code blocksCopy
deploymentIDs=klor1w3y00uqay7gkop17,kxfmz19qfoks0gk9xmjok

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the getDeploymentsById operation:

Use dark colors for code blocksCopy
POST /<context>/admin/system/deployments/getDeploymentsById HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

deploymentIDs=klor1w3y00uqay7gkop17,kxfmz19qfoks0gk9xmjok&f=pjson&token=<token>

JSON Response example

Use dark colors for code blocksCopy
{
  "deployments": [
    {
      "mode": "Shared",
      "configuredState": "STARTED",
      "provider": "DMaps",
      "deploymentId": "klor1w3y00uqay7gkop17",
      "name": "shared-mapserver",
      "type": "MapServer",
      "spec": {
        "servicesFilter": {
          "serviceType": "MapServer",
          "providerType": "DMaps"
        },
        "replicas": {
          "min": 2,
          "max": 2,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "customResources": {},
              "cpuMax": "2"
            },
            "containerImageUrl": "container.image.com/map-server:6243",
            "containerImageKey": "MAP_SERVER"
          },
          {
            "name": "fluent-bit",
            "resources": {
                "memoryMin": "32Mi",
                "memoryMax": "150Mi",
                "cpuMin": "0.05",
                "customResources": {},
                "cpuMax": "0.25"
            },
            "containerImageUrl": "container.image.com/arcgis-fluent-bit:6243",
            "containerImageKey": "FLUENT_BIT"
          }
        ],
        "initServices": {
          "serviceNames": [
            {
              "serviceType": "MapServer",
              "folderName": "System",
              "serviceName": "SharedMapServiceHost",
              "serviceId": "sk2t7le4zicjl7cp6edpb"
            }
          ]
        },
        "managedKubernetesResources": [
          {
            "purpose": "blue-deployment",
            "kind": "Deployment",
            "name": "arcgis-klor1w3y00uqay7gkop17-mapserver-qtuaj",
            "selectorInstanceName": "blue"
          },
          {
            "purpose": "service",
            "kind": "Service",
            "name": "arcgis-klor1w3y00uqay7gkop17-mapserver",
            "selectorInstanceName": "blue"
          }
        ]
      },
      "labels": {},
      "revision": 1729164716995
    },
    {
      "mode": "Dedicated",
      "configuredState": "STARTED",
      "provider": "ArcObjects11",
      "deploymentId": "kxfmz19qfoks0gk9xmjok",
      "name": "sampleworldcities-mapserver",
      "type": "MapServer",
      "spec": {
        "servicesFilter": {
          "serviceType": "MapServer",
          "folderName": "",
          "serviceId": "sh1pqzlvaq0qzbj3shv7j",
          "serviceName": "SampleWorldCities",
          "providerType": "ArcObjects11"
        },
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "2Gi",
              "cpuMin": "0.125",
              "customResources": {},
              "cpuMax": "2"
            },
            "containerImageUrl": "container.image.com/map-server:6243",
            "containerImageKey": "MAP_SERVER"
          },
          {
            "name": "fluent-bit",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "150Mi",
              "cpuMin": "0.05",
              "customResources": {},
              "cpuMax": "0.25"
            },
            "containerImageUrl": "container.image.com/arcgis-fluent-bit:6243",
            "containerImageKey": "FLUENT_BIT"
          }
        ],
        "managedKubernetesResources": [
          {
            "purpose": "blue-deployment",
            "kind": "Deployment",
            "name": "arcgis-kxfmz19qfoks0gk9xmjok-mapserver-pzf2k",
            "selectorInstanceName": "blue"
          },
          {
            "purpose": "service",
            "kind": "Service",
            "name": "arcgis-kxfmz19qfoks0gk9xmjok-mapserver",
            "selectorInstanceName": "blue"
          }
        ]
      },
      "labels": {},
      "revision": 1729164717466
    }
  ]
}