#Right API Call

1 messages · Page 1 of 1 (latest)

weak mountain
#

Does anyone know how I can find out the correct API call for a CLI command?

north wraith
#

You can search your api docs - https://<cluster_name>/docs/api

For example, if you search for "volume show", it should find it in the /storage/volumes api.

marble light
#

or use the show-ontapi command in the CLI:

cl::> security login role show-ontapi -command "volume create"
ONTAPI                      Command
--------------------------- ---------------------------------------------------
volume-create               volume create
volume-create-async         volume create
2 entries were displayed.
#

or rather show-rest for the REST API

# 
cl::*> security login role show-rest  -commands "volume create"
REST Endpoint               CLI Commands                   Supported Operations
--------------------------- ------------------------------ --------------------
/storage/volumes                                           GET, POST
                            security anti-ransomware volume show
                            security anti-ransomware volume space show
                            volume
                            volume clone create
                            volume clone show
                            volume create
                            volume efficiency show
                            volume encryption show
                            volume file async-delete client show
                            volume flexcache show
                            volume flexgroup show
                            volume move show
                            volume quota show
                            volume rebalance show
                            volume show
                            volume show-space
                            volume snaplock show
#

depending on the actual command and your ONTAP version, some commands might have only a REST API equivalent or only an ONTAPI equivalent