Skip to content
This repository was archived by the owner on Jan 9, 2021. It is now read-only.
This repository was archived by the owner on Jan 9, 2021. It is now read-only.

Support for API v2 #2

@markusressel

Description

@markusressel

From https://www.ixsystems.com/documentation/freenas/11.2/api.html:

A new API was released with FreeNAS® 11.1. The previous API is still present and in use because it is feature-complete. Documentation for the new API is available on the FreeNAS® system at the /api/docs/ URL. For example, if the FreeNAS® system is at IP address 192.168.1.119, enter http://192.168.1.119/api/docs/ in a browser to see the API documentation. Work is under way to make the new API feature-complete. The new APIv2 uses WebSockets. This advanced technology makes it possible to open interactive communication sessions between web browsers and servers, allowing event-driven responses without the need to poll the server for a reply. When APIv2 is feature-complete, the FreeNAS® documentation will include relevant examples that make use of the new API.

Some work has already been done like splitting the library in seperate modules for the different api versions and the groundwork for the websocket connection and message exchange.

Since API V2 is not officially feature complete yet, specific implementation of all possible api calls might be delayed up until official FreeNas release.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions