Forum Discussion

traphix's avatar
traphix
Icon for Altostratus rankAltostratus
Apr 02, 2025

iControl REST API: models + specifications?

Hi. In these docs we can find the endpoints and options for the REST API. https://clouddocs.f5.com/api/icontrol-rest/   We don't find the models/specifications that these endpoints return.  Eg. w...
api
automation
openapi
scripting
traphix's avatar
traphix
Icon for Altostratus rankAltostratus
Apr 07, 2025

Also, we might have found some inconsistencies. In the tmsh help for ltm pool members we find the following definition for 'state': 'up', 'down'.

However, from the API calls we get also values like 'user-down', 'user-up' and 'unchecked'. 

So, how can we get a complete list? The iControl REST API does not seem to simply be a tmsh wrapper. 

Thank you for clarifications. 

 

  • JRahm's avatar
    JRahm
    Icon for Admin rankAdmin
    Apr 07, 2025

    ah...yes. That's true. It is a wrapper, but not a perfect one unfortunately, and the list you are looking for doesn't exist. We had a python project (https://github.com/F5Networks/f5-common-python/tree/development/f5/bigip) that is no longer actively maintained that attempted to smooth out these inconsistencies and you'll find the ones we managed in there. You'll also find some objects do things like this:

    enabled: true and disabled: true

    instead of:

    enabled: true|false

    So you'll need to pop attributes sometimes before resubmitting them for an update.