API via POSTMANHello - I'm trying to make ontap cluster API calls via postman with token based | NetApp | Page 1

misty tundra Dec 11, 2023, 6:17 PM

#

I see API catalog for Active IQ, where can I find API catalog for the Ontap Cluster itself and how to generate Token of the ONTAP cluster to run the GET,POST etc through POSTMAN using Token based authentication? Please advise.

terse panther Dec 13, 2023, 1:26 AM

#

the cluster swagger page is located at https://cluster-name-or-ip/docs/api/

you can set postman to basic authentication and it will encrypt the credentials for you. that same encrypted credential can be used for other apis that use the same credentials.

#

it looks like there might be tokens if you set up oauth in 9.14, but that's not something i've looked at in any detail yet.

https://docs.netapp.com/us-en/ontap/authentication/overview-oauth2.html

Overview of the ONTAP OAuth 2.0 implementation

Beginning with ONTAP 9.14, you have the option to control access to your ONTAP clusters using the Open Authorization (OAuth 2.0) framework. You can configure...

#

token based authentication does not exist in ontap for versions prior to 9.14

misty tundra Dec 13, 2023, 3:05 PM

#

fantastic. thanks a lot @terse panther

#

in POSTMAN there is no option than Basic Auth to do requests right?

terse panther Dec 13, 2023, 6:50 PM

#

Postman itself has many auth options, but nothing else that would work with the older ontap versions.

bright hearth Dec 13, 2023, 11:40 PM

#

Maybe I'm not understanding the question completely - but you can use the AIQUM API Gateway to send/receive API calls to the clusters managed by AIQUM. AIQUM will handle the individual cluster credentials for you so you only need the AIQUM token in the header of the API and the URI will start with the cluster UUID. It is basically a passthrough request where the gateway will attach the cluster credential it has stored already

https://docs.netapp.com/us-en/active-iq-unified-manager/api-automation/concept_gateway_apis.html

Accessing ONTAP APIs through proxy access

The gateway APIs provide you with the advantage of using the Active IQ Unified Manager credentials to run ONTAP REST APIs and managing storage objects. These...

#

...and it works with Postman 😃

terse panther Dec 14, 2023, 12:35 AM

#

but that 'aiqum token' is still basic auth. there is no api token for um either. the only thing that has a token here is the ActiveIQ digital advisor site.

#

sure, you don't need the cluster credentials, but you'll need to use the um credentials to use that gateway

bright hearth Dec 14, 2023, 2:13 AM

#

Ah - I'm in the process of loading ONTAP Select 9.14.1 - I'll see if/how the OAuth functionality works - I'm obviously curious too! 🙃

#API via POSTMANHello - I'm trying to make ontap cluster API calls via postman with token based