Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
...
The following is the summary of the ONOS REST API.
| Table of Contents | ||
|---|---|---|
|
Please note that the all endpoints need to be prefixed with: http://<controller IP>:8181/onos/v1/
Example: http://127.0.0.1:8181/onos/v1/devices if onos ONOS is running on your local machine.
...
The entries in bold are currently implemented.
Device
| GET /devices | Lists all infrastructure devices. |
| GET /devices/{deviceId} | Lists details of a specific infrastructure device. |
| GET /devices/{deviceId}/ports | Lists ports of a specific infrastructure device. |
| POST /devices | Creates a new infrastructure device into inventory (future). |
| PUT /devices/{deviceId} | Updates a device - attributes, availability, mastership. |
| DELETE /devices/{deviceId} | Deletes an infrastructure device from inventory. |
...
| GET /intent/{intent-id} | Gets the details for the given Intent object. |
| GET /intents | Gets a collection containing all the Intent objects currently in the system. |
| POST /intent | Creates a new Intent object. |
| POST /intents | Creates a batch of Intent objects (pending -may not be included in finalized API). |
| DELETE /intent/{Intent-id} | Removes an intent from the system. |
...
Previous : Appendix A : List of ONOS Test Scripts (onos-* scripts)
Next : Appendix C : Source Tree Organization
...