Noun | URI | Verb | Query parameters | Comments | OF version |
Versions | {base_uri} | GET | | List all available API versions on this controller | |
{base_uri}/{api} | GET | | List all documentation available for this API | |
Authentication | /auth | POST | login | Use Keystone to authenticate and receive an X-Auth tokenfor use with authenticated APIs. | |
/auth | DELETE | token | Invalidates a given X-Auth token so it may no longer be used to authenticate with an API. | |
Support | /support | GET | id, fields | Get a report of support information | |
Licensing | /licenses | GET | key | List all licenses | |
/licenses | POST | | Add a license | |
/licenses/installid | GET | | Get install id | |
/licenses/{sno} | GET | | Get license info with the given serial number (sno) | |
/licenses/{sno}/action | POST | | Perform an action (deactivate) on the license with the given serial number | |
/licenses/islicensed | GET | product_id | Check if a product/app is licensed or not | |
/licenses/compliance | GET | product_id, metric_id | Get license compliance level (0 to 1) for a product id and a metric id. The resulting compliance level will be in the range 0 to 1.0, where 1.0 is fully compliant and 0 is not licensed. Any other fraction between the range is nothing but partially complaint | |
Config | /configs | GET | | List all configurations | |
/configs/{component} | GET | | List configurations for the given component | |
/configs/{component} | PUT | | List the configurations for the given component | |
/configs/{component} | DELETE | | Parse delete the specified configurations for the given component (deleted configuration items will revert to their default values) | |
Apps | /apps | GET | | List all apps deployed on this controller | |
/apps | POST | | Deploy a new app to staging to run on the HP VAN SDN Controller | |
/apps/{app_uid} | DELETE | | Undeploy an app | |
/apps/{app_uid} | PUT | | Redeploy an app to staging | |
/apps/{app_uid} | GET | | Get app information (like vendor, version, etc…) | |
/apps/{app_uid}/action | POST | | Take an action (install/start/stop) on the given app | |
/apps/{app_uid}/health | GET | | Get app health | |
/apps/{app_uid}/health | HEAD | | Monitor app health | |
Logs | /logs | GET | | Get team log files | |
/logs/local | GET | | Get local log files | |
Audit Logs | /auditlog | GET | user, activity, start, end | Export team audit logs | |
Systems | /systems | GET | ip | List of all controllers | |
/systems/{system_uid} | GET | | Get info on a controller | |
/systems/{system_uid} | PUT | | Update the IP address of a non-teamed controller | |
Region | /regions | GET | | List device regions | |
/regions | POST | | Create a new device region | |
/regions/{region_uid} | GET | | Get a device region | |
/regions/{region_uid} | PUT | | Update a device region | |
/regions/{region_uid} | DELETE | | Delete a device region | |
Team | /team | GET | | Get team configuration | |
/team | POST | | Create/Form new team | |
/team | DELETE | | Delete/disband team | |
Backup | /backup/status | GET | | Get Backup status | |
/backup/checksum | GET | | Get checksum of the backup file stored on the controller | |
/backup | GET | | Download the backup file from the controller | |
/backup | POST | | Start the backup | |
Restore | /restore | POST | | Start the restore | |
/restore/status | GET | | Get the restore status | |
/restore/backup | POST | | Upload a backup file onto the controller for restore purposes | |
Alerts | /alerts | GET | | List all alerts | |
/alerts/topics | GET | org | List all alert topics | |
/alerts/listeners | GET | | List all listeners | |
/alerts/listeners | POST | | Create a listener to one or more topics | |
/alerts/listeners/ {listener_uid} | GET | | Get info on a listener | |
/alerts/listeners/ {listener_uid} | DELETE | | Remove a listener | |
/alerts/listeners/ {listener_uid} | PUT | | Update a listener | |
Metrics | /metrics/apps | GET | | List the names and IDs of all applications that have metrics persisted on the system | |
/metrics/primaries | GET | app_id, name, secondary_tag | List all primary tags based on the query parameters | |
/metrics/secondaries | GET | app_id, name, primary_tag | List all secondary tags based on the query parameters | |
/metrics/names | GET | app_id, name, secondary_tag | List all metric names based on the query parameters | |
/metrics | GET | app_id, name, primary_tag, secondary_tag | List all metrics based on the query parameters | |
/metrics/{metric_uid} | GET | | List detail of the metric | |
/metrics/{metric_uid}/ values | GET | | Return the values of the specified metric | |