Status (Service)

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

Description

The status resource provides the configured and current status of a GIS service. The configured status represents the state of the resource as it is configured. For example, starting a service sets its configured status to STARTED. However, he configured state may not match the current state of the resource. For the current state of the service, review the value returned by the realTimeState property.

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails

configuredState

The configured state of the resource. The default state is STOPPED.

Values: STOPPED | STARTED

realTimeState

The actual (current) state of the resource.

Values: STOPPED | STARTED

Example usage

The following is a sample request URL used to access the status resource:

Use dark colors for code blocksCopy
1
https://organization.domain.com/context/admin/services/Hosted/SampleService.FeatureServer/status?f=pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
{
  "configuredState": "STARTED",
  "realTimeState": "STARTED"
}

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