You must enable javascript in order to view this page or you can go
here
to view the webhelp.
Contents
Search
Loading, please wait ...
ArubaOS-CX 10.04 REST v1 API Guide
Home
About this document
Applicable products
Latest version available online
Command syntax notation conventions
About the examples
Identifying switch ports and interfaces
Identifying switch components
Introduction to the ArubaOS-CX REST API
ArubaOS-CX REST API
ArubaOS-CX system databases
REST API versions
Getting the REST API versions on the switch
Authentication of REST API sessions
User groups and access authorization
REST API access modes
Write methods (POST, PUT) supported in read-only mode
REST requests and accounting logs
Parts of a URI
URI path, including path parameters
Query component
Resources
Resource collections and singletons
Categories of resource attributes
ArubaOS-CX REST API reference summary
Enabling access to the REST API
Setting the admin password
Setting the REST API access mode to read/write
Showing the REST API access configuration
Disabling access to the REST API
Ways to access the ArubaOS-CX REST API
Accessing the REST API using the ArubaOS-CX REST API Reference
Logging in and logging out using the ArubaOS-CX REST API Reference
ArubaOS-CX REST API Reference basics
Accessing the REST API using curl
Logging in using curl
Logging out using curl
More information about curl
About the curl command examples
GET method usage and considerations
Wildcard character support
Attributes parameter
GET method parameters
Count parameter
Depth parameter
Filter parameter
Selector parameter
Write methods (POST, PUT, and DELETE)
Considerations when making configuration changes
Considerations for ports and interfaces
POST method usage and considerations
PUT method usage and considerations
Best practice method for building the PUT request body
DELETE method usage and considerations
VSX peer switches and REST API access
ArubaOS-CX real-time notifications subsystem
Secure WebSocket Protocol connections for notifications
Notification topics are switch resource URIs
Rules for topic URIs
Notification security features
ArubaOS-CX real-time notifications subsystem reference summary
Enabling the notifications subsystem on a switch
Establishing a secure WebSocket connection through a web browser
Establishing a secure WebSocket connection using a script
Subscribing to topics
Unsubscribing from topics
Getting information about current subscribers and subscriptions
Parts of a subscribe message
Parts of a subscription success message
Parts of a notification message
Example: Python-based notification subscriber
Example: Browser-based WebSocket connection
Example: Getting information about notification subscriptions
Examples
Examples: GET method
Example: Getting and deleting certificates using REST APIs
Example: Generating a self-signed certificate using REST APIs
Example: Getting and installing a signed leaf certificate using REST APIs
Example: Associating a leaf certificate with a switch feature using REST APIs
Example: Configuration management using REST APIs
Example: Firmware upgrade using REST APIs
Example: Log operations using REST APIs
Example: Ping operations using REST APIs
Example: Traceroute operations using REST APIs
Example: User management using REST APIs
Example: Creating an ACL with a port using REST APIs
Example: Creating a VLAN with a port using REST APIs
Example: Changing an interface from layer 3 to layer 2
Examples: Interacting with a VSX peer switch
HTTPS server commands
https-server rest access-mode
https-server session close all
https-server vrf
show https-server
REST API response codes
Troubleshooting
General troubleshooting tips
Differences among REST API versions
Error "'admin' password is not set"
Error "certificate verify failed" returned from curl command
HTTP 400 error "Invalid Operation"
HTTP 400 error "Value is not configurable"
HTTP 400 error "Reference failure"
HTTP 401 error "Authorization Required"
HTTP 401 error "Login failed: session limit reached"
HTTP 403 error "Forbidden" on a write request
HTTP 403 error "Forbidden" on a GET request
HTTP 404 error when accessing the switch URL
HTTP 404 error "Object not found" on object with "bridge/" in URI Path
HTTP 404 error "Object not found" returned from a switch that supports multiple REST API versions (10.04)
HTTP 404 error "Object not found" when using a write method
HTTP 404 error "Page not found" when using a write method
Logout fails
Websites
Support and other resources
Accessing Hewlett Packard Enterprise Support
Accessing updates
Remote support
Warranty information
Regulatory information
Documentation feedback
Your browser does not support iframes.