- URL:
- https://<root>/system/deployments/findDeploymentIds
- 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.
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 find 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
| Parameter | Details |
|---|---|
(Optional) | The name of the microservice. |
(Optional) | The microservice type. For example, if the microservice is a shared feature server containing feature services, the type will be Values: |
(Optional) | The microservice provider. Only microservices related to an ArcGIS service type will have a provider type. A provider type of Values: |
(Optional) | The microservice mode. A mode type of Values: |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the find operation:
POST /<context>/admin/system/deployments/findDeploymentIds HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
filterName=&filterType=MapServer&filterProvider=&filterMode=Dedicated&f=pjson&token=<token>JSON Response example
{
"filteredDeploymentIds": [
"kvpn5amtms629i91g495l",
"khaz9zt1kc2vv3ddze53z",
"kjv6p253atz10y5vspacp",
"km55oijxo9isjdkc7p1dy",
"knikeh3dgctrydgksn87a",
"kw7uj7bzor76qy5qjshrm",
"kyc9bd9f9u8bxd65a9que",
"kywkyoun3ajo5kg3l2dip",
"kc9zgyfbx6py1rzgexdu7",
"kd8jidy7f6bxtosrd80hz",
"kz4lxot10wkj3lbiw3mz0",
"kz9gn9gtwljgzw9ol2vtg",
"kcta2dvi033wlnav5h7x7",
"ky5edsfoskyhc7egkna94",
"kwswm4u7pk6rtf6pa4fc8"
]
}