- URL:
- https://<root>/machines/<machine>
- Methods:
GET- Child Resources:
- SSL Certificates, Hardware Info
- Version Introduced:
- 10.8
Access requirements
Required privileges
The Portal 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 Portal 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 Portal Administrator API must include a token in the request body.
Description
The resource for an individual machine returns information on a specific portal machine registered with ArcGIS Enterprise portal, such as the administrative URL for the machine and its OS platform information. A portal machine represent a machine on which Portal for ArcGIS software has been installed and licensed. From this resource, you can review the status of the machine and manage SSL certificates when in a highly available portal environment.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response value is Values: |
Example usage
The following is a sample request URL used to access an individual machine resource:
https://organization.example.com/<context>/portaladmin/machines/MACHINE.EXAMPLE.COM?f=pjsonJSON Response syntax
{
"machineName": "<machine name>",
"adminURL": "<admin URL>",
"role": "<standby|primary>",
"platform": "<OS platform information>"
}JSON Response example
{
"machineName": "MACHINE.EXAMPLE.COM",
"adminURL": "https://machine.example.com:7443/arcgis",
"role": "primary",
"platform": "Linux-amd64-5.4.17-2136.301.1.4.el8uek.x86_64"
}