Create a Post
cancel
Showing results for 
Search instead for 
Did you mean: 
Haim_Gabay
Explorer

Document for REST API on Quantum 1500

Hello Community team,

From my understanding, the support for REST API in Quantum 1500 was added in R80.20.25 firmware, I am looking for a document that describe in detail all the supported commands, I appreciate if someone can share with me the link for the document

Thanks

0 Kudos
1 Reply
PhoneBoy
Admin
Admin

I believe we are still working on the official documentation.
However, the attached should be enough to get started.
There are only four API commands currently:

  • login
  • logout
  • run-clish-command
  • generate-report

A couple other notes:

  • The API runs on port 4434 by default
  • It uses the 'web-api' context by default (the regular Management API uses web_api).

Which means if you're using mgmt_cli to execute API commands, you'd be executing something like:

mgmt_cli --port 4434 -m 192.168.1.1 --context web-api login

Hope that helps.

Leaderboard

Epsum factorial non deposit quid pro quo hic escorol.

Upcoming Events

    Tue 23 Apr 2024 @ 11:00 AM (EDT)

    East US: What's New in R82

    Thu 25 Apr 2024 @ 11:00 AM (SGT)

    APAC: CPX 2024 Recap

    Tue 30 Apr 2024 @ 03:00 PM (CDT)

    EMEA: CPX 2024 Recap

    Thu 02 May 2024 @ 11:00 AM (SGT)

    APAC: What's new in R82

    Tue 23 Apr 2024 @ 11:00 AM (EDT)

    East US: What's New in R82

    Thu 25 Apr 2024 @ 11:00 AM (SGT)

    APAC: CPX 2024 Recap

    Tue 30 Apr 2024 @ 03:00 PM (CDT)

    EMEA: CPX 2024 Recap

    Thu 02 May 2024 @ 11:00 AM (SGT)

    APAC: What's new in R82
    CheckMates Events