REST API Query

Question

I would like to get the status of the pool and web servers [online/offline] via rest API. I’ve gone through the API documentation but couldn’t figure out what should be my API call.

Can someone here please help?

alexbct · Accepted Answer

Hi, &nbsp;Have you seen this one? https://devcentral.f5.com/s/question/0D51T00006i7Yj4/icontrol-rest-getting-pool-member-status&nbsp;Basically, this should be your curl request (change the name of the pool/IP and add user/pass): &nbsp;curl --request GET --url 'https://192.168.10.31/mgmt/tm/ltm/pool/~Common~wiki-pool/members/stats'&nbsp;

iazhar · Answer

Thanks &nbsp;, I am able to use this to get a response.In the API response, I am assuming the key "monitorStatus" indicates whether the member is down or up, is this correct?

iazhar · Answer

Also, how can I check if a virtual server is up/down via rest call?

alexbct · Answer

Basically anything can be found via iControl, but can be a bit of a search at first. Anything to do with virtual servers, can be found under /mgmt/tm/ltm/virtual (the structure is very similar to TMSH commands). Have a look here for the full guide and setup required for any iControl requests;

https://clouddocs.f5.com/api/icontrol-rest/

Whenever I need to build any iControl commands, I use these pages to reference material.

alexbct · Answer

That's correct. &nbsp;If you look a bit further down in the response, you can also find these entries; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sessionStatus": {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description": "user-disabled"&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status.availabilityState": {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description": "offline"&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status.enabledState": {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description": "disabled"&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status.statusReason": {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description": "Forced down"&nbsp;This is showing you if the member is administratively down (Disabled / Forced Offline) - the example above is showing it with Forced Offline configured. &nbsp;If you're happy with the answer. Would be great if you can flag the item as "Answered" so it can be closed and may benefit the rest of the community.

Forum Discussion

REST API Query

5 Replies

Recent Discussions

import live updates from version x to version y

Tenant image upgrade

iRule editor partition button does not work

F5Access | MacOS Sonoma

Overwriting or adding LTM SSL Traffic cert and key using iControlREST

Related Content

Modify SSL profiles via REST API

APIs Everywhere

Beyond REST: Protecting GraphQL

PowerShell module for the F5 LTM REST API

Using iControl REST API to manage F5 BIG-IP Advanced Firewall Manager (AFM)