topic Re: Portal Admin Machines REST in ArcGIS REST APIs and Services Questions

Portal Admin Machines REST

DeanHowell1 — Fri, 04 Dec 2020 03:00:49 GMT

We need to be able to query the REST end point for the portal machines to determine the primary and standby machines but not sure what the syntax needs to be for accessing it outside the portal administrator.

The REST end point is https://admin.portal...../arcgis/portaladmin/machines?f=pjson which works when I am in the portal admin but how do we add this to an external application with credentials / token?

Re: Portal Admin Machines REST

DavidPike — Fri, 04 Dec 2020 19:06:11 GMT

would you want to do this with requests or the rest api for python?

Re: Portal Admin Machines REST

DeanHowell1 — Sat, 05 Dec 2020 06:01:53 GMT

Thanks @DavidPike we are looking to do as a request from an external script that needs to shut down the portal in a specific order depending on the machine status in HA

@DavidPike wrote:
would you want to do this with requests or the rest api for python?

Re: Portal Admin Machines REST

DavidPike — Sat, 05 Dec 2020 12:06:12 GMT

gotcha, so you'd want to do a health check via the REST API Health Check—ArcGIS REST API | ArcGIS for Developers but need to know how to generate and attach the token for access?

Re: Portal Admin Machines REST

DeanHowell1 — Sat, 05 Dec 2020 23:25:58 GMT

Yes exactly. We are stuck on how to create and pass the relevant credentials through to the rest end point

Re: Portal Admin Machines REST

DavidPike — Sun, 06 Dec 2020 00:27:55 GMT

I think the health check doesn't require a toke give the url a try.

Re: Portal Admin Machines REST

DeanHowell1 — Sun, 06 Dec 2020 23:05:57 GMT

Thanks again @DavidPike, yes the healthCheck works without a token but it is the machines that I need to query but have just found the help page for the machines which might give some greater insight https://developers.arcgis.com/rest/enterprise-administration/portal/status.htm

Re: Portal Admin Machines REST

DavidPike — Mon, 07 Dec 2020 12:04:50 GMT

ah gotcha,

So the initial query is to get the machine names:

https://machine.domain.com/webadaptor/portaladmin/machines

then the status for each machine:

https://machine.domain.com/webadaptor/portaladmin/machines/status/MACHINE.DOMAIN.COM?f=json

the token is generated with:

import requests portalUrl = "https://domain/portal" username = 'username' password = "password" def generateToken(username, password, portalUrl): # Retrieves a token to be used with API requests. headers = {'content-type': 'application/x-www-form-urlencoded'} parameters = {'username': username, 'password': password, 'client': 'referer', 'referer': portalUrl, 'expiration': 60, 'f': 'json'} url = portalUrl + '/sharing/rest/generateToken?' response = requests.post(url, data=parameters, headers=headers) try: jsonResponse = response.json() if 'token' in jsonResponse: return jsonResponse['token'] elif 'error' in jsonResponse: print (jsonResponse['error']['message']) for detail in jsonResponse['error']['details']: print (detail) except ValueError: print('An unspecified error occurred.') print(ValueError) token = generateToken(username, password, portalUrl) print(token)

Re: Portal Admin Machines REST

DavidPike — Mon, 07 Dec 2020 12:06:12 GMT

then any url GETs will just be appended with:

"&token=" + token

Re: Portal Admin Machines REST

DeanHowell1 — Mon, 07 Dec 2020 21:35:37 GMT

Thanks @DavidPike once again very much appreciated.

Does the token need to be generated for the specific page / URL that you are trying to access or just for the portal?

Re: Portal Admin Machines REST

DavidPike — Mon, 07 Dec 2020 21:43:13 GMT

did it work for you?

The token will last until it expires (in my example 60 minutes) and can be used for any query and doesn't need to be regenerated for a new query (if not expired of course).

You can also encode the token in a json request, but I get to the stage with this stuff that I'm happy if anything just works.

Re: Portal Admin Machines REST

DeanHowell1 — Mon, 07 Dec 2020 22:25:18 GMT

Thanks @DavidPike that is working, almost as it looks like we have some firewall issues 🙂

Re: Portal Admin Machines REST

DeanHowell1 — Tue, 08 Dec 2020 00:44:01 GMT

Hello @DavidPike I have been told that there is a proxy in place and that could be causing the issue of not being able to get the results I need. Do you know how to use the proxy https://cls-bx-proxy with what you have suggested above?

Re: Portal Admin Machines REST

DavidPike — Tue, 08 Dec 2020 00:57:59 GMT

can you elaborate on the issue?

Re: Portal Admin Machines REST

DeanHowell1 — Tue, 08 Dec 2020 01:39:43 GMT

I am getting a token returned using the script but I then get a 'Forbidden 403' message. So it has been suggested to use the proxy server but not sure how to configure that into the script.