- URL:
- https://<root>/system/platformservices
- Methods:
GET- Child Resources:
- Platform Service
- Version Introduced:
- 10.5
Access requirements
Required privileges
The Sever 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.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The platformservices resource allows you to view and manage your platform services in the ArcGIS Server Administrator Directory. The Compute Platform and Synchronization services are used by GeoAnalytics Server. For each platform service, you can start it, stop it, and view its status. While a health check operation is exposed for all three platform services, only Compute Platform Health Check returns valuable information.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the platformservices resource:
https://organization.example.com/<context>/admin/system/platformservices?f=pjson