Loading, please wait ...
- Home
- About this document
- Introduction to the AOS-CX REST API
- AOS-CX REST API
- AOS-CX system databases
- 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
- REST API version
- Parts of a URI
- Resources
- Categories of resource attributes
- Why to use a REST API
- AOS-CX REST API reference summary
- Enabling access to the REST API
- Ways to access the AOS-CX REST API
- GET method usage and considerations
- Write methods (POST, PUT, and DELETE)
- VSX peer switches and REST API access
- AOS-CX real-time notifications subsystem
- Secure WebSocket Protocol connections for notifications
- 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
- REST API response codes
- Troubleshooting
- General troubleshooting tips
- 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" when using a write method
- HTTP 404 error "Page not found" when using a write method
- Logout fails
- Websites
- Support and other resources