Find Deployment IDs

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

Description

The findDeploymentIds operation queries and returns a list of IDs for microservices within ArcGIS Enterprise on Kubernetes that match the filter criteria. Results can be filtered by specifying the name, type, provider, and mode of a microservice. These filters are optional; if no filter is applied, the IDs of every microservice is returned in the response.

Request parameters

ParameterDetails

filterName

(Optional)

The name of the microservice.

1
filterName=shared-mapserver

filterType

(Optional)

The microservice type. For example, if the microservice is a shared feature server containing feature services, the type will be FeatureServer.

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

filterProvider

(Optional)

The microservice provider. Only microservices related to an ArcGIS service type will have a provider type. A provider type of Undefined is used for nonservice-related microservices (such as Admin API, portal sharing, and ingress controller).

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

filterMode

(Optional)

The microservice mode. A mode type of Undefined is used when the microservices is system related (such as Admin API, portal sharing, and ingress controller). Only microservices related to an ArcGIS service type use either the Dedicated or Shared value for this parameter.

Values: Shared | Dedicated | Undefined | Primary | Standby | Coordinator

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

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

1
2
3
4
5
6
POST /context/admin/system/deployments/findDeploymentIds HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

filterName=&filterType=MapServer&filterProvider=&filterMode=Dedicated&f=pjson&token=<token>

JSON Response example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "filteredDeploymentIds": [
    "kvpn5amtms629i91g495l",
    "khaz9zt1kc2vv3ddze53z",
    "kjv6p253atz10y5vspacp",
    "km55oijxo9isjdkc7p1dy",
    "knikeh3dgctrydgksn87a",
    "kw7uj7bzor76qy5qjshrm",
    "kyc9bd9f9u8bxd65a9que",
    "kywkyoun3ajo5kg3l2dip",
    "kc9zgyfbx6py1rzgexdu7",
    "kd8jidy7f6bxtosrd80hz",
    "kz4lxot10wkj3lbiw3mz0",
    "kz9gn9gtwljgzw9ol2vtg",
    "kcta2dvi033wlnav5h7x7",
    "ky5edsfoskyhc7egkna94",
    "kwswm4u7pk6rtf6pa4fc8"
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close