Find Services

URL:
https://<root>/services/findServices
Methods:
POST
Required Capability:
Access allowed with either the "Update", "Delete", or "Security and infrastructure" privileges, or the Publisher role
Version Introduced:
10.9

Description

The findServices operation queries and returns a list of the services within the deployment. The results can be fine-tuned by specifying the folder location, service type, ID, or service provider. These filters are optional; if no filter is applied, all services are returned by the operation.

Request parameters

ParameterDetails

filterFolderName

(Optional)

Filters services by their folder location.

Example
1
filterFolderName=Hosted

filterServiceName

Filters services by their name.

Example
1
filterServiceName=Countries

filterServiceType

(Optional)

Filters services by their service type.

Example
1
filterServiceType=FeatureServer

filterServiceId

(Optional)

Filters services by their specific service IDs.

Example
1
filterServiceId=s0378d7fd-2731-49da-9ef9-d0c9cae563bb

filterProvider

(Optional)

Filters services by their provider types.

Values: ArcObjects11 | SDS

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the findServices operation that queries services for Feature Services with SDS as a provider type in the Hosted folder:

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

filterFolderName=Hosted&filterServiceType=FeatureServer&filterServiceId=&filterServiceProvider=SDS&f=pjson&token=yJEfZxDMUpJmeqJlA_A0H-WOROxeSslL8m704pDFu2uwxFSLQnjewhuKpXYXOLVZjAs_HWh6JhldUnjfyG10PrSEOIrZ8O-LzgWVHwl7LaklYuXru_Jkg0UxGxVE9YIHc_M2yi6wT7rS4b7MSStBVIwTL1ZND5JjXJYsvcXJvtqF-58Dz16zuq-JtC03EEvkxF8rxlqRkBs8V_ti_zkBPfLbq_BnhjJAcSsyP5___4P_6UJDt6odF83azx-fobQq

JSON Response example

The following is an abbreviated response for the example usage above:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "filteredServices": [
    {
      "id": "s0378d7fd-2731-49da-9ef9-d0c9cae563bb",
      "serviceName": "Countries",
      "type": "FeatureServer",
      "folderName": "Hosted",
      "description": "",
      "capabilities": "Query",
      "provider": "SDS",
      "clusterName": "default",
      "minInstancesPerNode": 0,
      "maxInstancesPerNode": 0,
      "instancesPerContainer": 1,
      "maxWaitTime": 60,
      "maxStartupTime": 300,
      "maxIdleTime": 1800,
      "maxUsageTime": 600,
      "loadBalancing": "ROUND_ROBIN",
      "isolationLevel": "HIGH",
      "configuredState": "STARTED",
      "recycleInterval": 24,
      "recycleStartTime": "00:00",
      "keepAliveInterval": 1800,
      "private": false,
      "isDefault": false,
      "maxUploadFileSize": 0,
      "allowedUploadFileTypes": "",
      "properties": {...},
      "jsonProperties": {...},
      "portalProperties": {...},
      "extensions": [],
      "frameworkProperties": {},
      "datasets": [],
      "serverId": "v7bed0815-d718-45bc-8d30-8264c51933af"
    }
  ]
}

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