1. Technologies Technologies
  2. Networking
  3. APIC Enterprise Module
  • Learn
  • Docs
  • Community
  • Support
APIC-EM v1.x Developer Docs
  • Guides
    • Errata
      • Sandboxed Versions of the Cisco APIC-EM
      • Getting Started Guides
      • API Documentation
      • Updates
    • Overview
    • Getting Set Up
    • Hello World
    • Getting Started with APIC-EM v. 1.5.x
      • Getting Started with Cisco APIC-EM
        • Introduction
        • Audience
        • Document Conventions
          • Replaceable Values in REST Request Paths
        • Related Documentation
        • Obtaining Documentation and Submitting a Service Request
      • What is Cisco APIC-EM?
        • About the Cisco Application Policy Infrastructure Controller Enterprise Module (APIC-EM)
        • Cisco APIC-EM GUI
      • Logging in to the Cisco APIC-EM Controller
        • Choosing a Cisco APIC-EM Controller
          • Using This Guide Outside of the DevNet Sandbox
        • Using the Always-On Cisco APIC-EM Sandbox
        • Using a Reservation-Based Cisco APIC-EM Sandbox
          • E-mails That the Reservation System Sends
          • Installing the Cisco AnyConnect Secure Mobility Client
          • Reserving a Sandbox for Private Use
          • Establishing a VPN Connection to Your Reserved Sandbox
          • Finding the Controller's Login Page
          • Getting Administrative Login Credentials
          • Logging in to the APIC-EM Graphical User Interface (GUI)
        • Quick Tour of the APIC-EM Graphical User Interface (GUI)
      • Getting Information About Your Network
        • Automated Discovery
        • Getting Scanning Credentials
        • Discovering Devices and Hosts
        • Device Inventory
          • Viewing the Device Inventory
          • Viewing Information About an Individual Device
          • Customizing the Device Inventory Table
          • Viewing the Running Configuration of an Individual Device
        • Host Inventory
          • Viewing and Filtering the Host Inventory
        • Topology
          • Trying out the Topology Tools
          • Configuring Topology Viewing Preferences
      • Managing Devices
        • Using Tags
          • Working with Tags in Device Inventory
            • CreatingDevice Tags in the Device Inventory
            • Viewing and Applying Device Tags in the Device Inventory
            • Untagging Devices in the Device Inventory
          • Working withDevice Tags in Topology View
            • Identifying Network Elements by Device Tag in Topology View
            • Creating and Applying a Device Tag on the Topology Page
            • Untagging Devices in Topology View
          • Deleting a Device Tag from the Available Tags List
        • Using Locations
          • Creating a Location in the Device Inventory
          • Viewing and Applying Locations in the Device Inventory
        • Tracing a Path
      • Prioritizing Network Traffic
        • Introduction to EasyQoS
        • Creating a Static QoS Policy
          • Creating Policy Scopes
          • Filtering Policy Scopes
          • Defining and Deploying Static QoS Policy
        • Creating a Dynamic QoS Policy
        • Editing a Policy Scope
        • Adding a New Packet Classifier
        • Customizing Existing Packet Classifiers
      • APIC-EM REST API
        • What is REST?
        • Introduction to the APIC-EM REST API
        • Installing an HTTP Client
        • Your First REST Request
        • Using the Online API Documentation
        • Access Controls
          • Groups and Roles
          • Group- and Role-Based Access Controls
        • Using Service Tickets
        • Managing Users and Roles Programmatically
          • Getting Users and Roles
          • Creating Users
          • Deleting Users
          • Updating User Account Information
        • Using ID Values in REST Requests
        • Getting Information About Asynchronous Operations
        • Discovering Devices and Hosts Programmatically
        • Additional REST API Activities
      • Next Steps
        • Experiment with RBAC Scopes
        • Observe GUI Use of the Northbound REST API
        • Experiment in Cisco DevNet Learning Labs
          • Accessing APIC-EM Learning Labs on DevNet
        • Explore Additional Cisco APIC-EM Documentation
    • Getting Started with APIC-EM v. 1.4.x
      • Getting Started with Cisco APIC-EM
        • Introduction
        • Audience
        • Document Conventions
          • Replaceable Values in REST Request Paths
        • Related Documentation
        • Obtaining Documentation and Submitting a Service Request
      • What is Cisco APIC-EM?
        • About the Cisco Application Policy Infrastructure Controller Enterprise Module (APIC-EM)
        • Cisco APIC-EM GUI
      • Logging in to the Cisco APIC-EM Controller
        • Choosing a Cisco APIC-EM Controller
          • Using This Guide Outside of the DevNet Sandbox
        • Using the Always-On Cisco APIC-EM Sandbox
        • Using a Reservation-Based Cisco APIC-EM Sandbox
          • E-mails That the Reservation System Sends
          • Installing the Cisco AnyConnect Secure Mobility Client
          • Reserving a Sandbox for Private Use
          • Establishing a VPN Connection to Your Reserved Sandbox
          • Finding the Controller's Login Page
          • Getting Administrative Login Credentials
          • Logging in to the APIC-EM Graphical User Interface (GUI)
        • Quick Tour of the APIC-EM Graphical User Interface (GUI)
      • Getting Information About Your Network
        • Automated Discovery
        • Getting Scanning Credentials
        • Discovering Devices and Hosts
        • Device Inventory
          • Viewing the Device Inventory
          • Viewing Information About an Individual Device
          • Customizing the Device Inventory Table
          • Viewing the Running Configuration of an Individual Device
        • Host Inventory
          • Viewing and Filtering the Host Inventory
        • Topology
          • Trying out the Topology Tools
          • Configuring Topology Viewing Preferences
      • Managing Devices
        • Using Tags
          • Working with Tags in Device Inventory
            • CreatingDevice Tags in the Device Inventory
            • Viewing and Applying Device Tags in the Device Inventory
            • Untagging Devices in the Device Inventory
          • Working withDevice Tags in Topology View
            • Identifying Network Elements by Device Tag in Topology View
            • Creating and Applying a Device Tag on the Topology Page
            • Untagging Devices in Topology View
          • Deleting a Device Tag from the Available Tags List
        • Using Locations
          • Creating a Location in the Device Inventory
          • Viewing and Applying Locations in the Device Inventory
        • Tracing a Path
      • Prioritizing Network Traffic
        • Introduction to EasyQoS
        • Creating a Static QoS Policy
          • Creating Policy Scopes
          • Filtering Policy Scopes
          • Defining and Deploying Static QoS Policy
        • Creating a Dynamic QoS Policy
        • Editing a Policy Scope
        • Adding a New Packet Classifier
        • Customizing Existing Packet Classifiers
      • APIC-EM REST API
        • What is REST?
        • Introduction to the APIC-EM REST API
        • Installing an HTTP Client
        • Your First REST Request
        • Using the Online API Documentation
        • Access Controls
          • Groups and Roles
          • Group- and Role-Based Access Controls
        • Using Service Tickets
        • Managing Users and Roles Programmatically
          • Getting Users and Roles
          • Creating Users
          • Deleting Users
          • Updating User Account Information
        • Using ID Values in REST Requests
        • Getting Information About Asynchronous Operations
        • Discovering Devices and Hosts Programmatically
        • Additional REST API Activities
      • Next Steps
        • Experiment with RBAC Scopes
        • Observe GUI Use of the Northbound REST API
        • Experiment in Cisco DevNet Learning Labs
          • Accessing APIC-EM Learning Labs on DevNet
        • Explore Additional Cisco APIC-EM Documentation
    • Getting Started with APIC-EM v. 1.3.x
      • Getting Started with Cisco APIC-EM
        • Introduction
        • Audience
        • Document Conventions
          • Replaceable Values in REST Request Paths
        • Related Documentation
        • Obtaining Documentation and Submitting a Service Request
      • What is Cisco APIC-EM?
        • About the Cisco Application Policy Infrastructure Controller Enterprise Module (APIC-EM)
        • Cisco APIC-EM GUI
      • Logging in to the Cisco APIC-EM Controller
        • Choosing a Cisco APIC-EM Controller
          • Using This Guide Outside of the DevNet Sandbox
        • Using the Always-On Cisco APIC-EM Sandbox
        • Using a Reservation-Based Cisco APIC-EM Sandbox
          • E-mails That the Reservation System Sends
          • Installing the Cisco AnyConnect Secure Mobility Client
          • Reserving a Sandbox for Private Use
          • Establishing a VPN Connection to Your Reserved Sandbox
          • Finding the Controller's Login Page
          • Getting Administrative Login Credentials
          • Logging in to the APIC-EM Graphical User Interface (GUI)
        • Quick Tour of the APIC-EM Graphical User Interface (GUI)
      • Getting Information About Your Network
        • Automated Discovery
        • Getting Scanning Credentials
        • Discovering Devices and Hosts
        • Device Inventory
          • Viewing the Device Inventory
          • Viewing Information About an Individual Device
          • Customizing the Device Inventory Table
          • Viewing the Running Configuration of an Individual Device
        • Host Inventory
          • Viewing the Host Inventory
          • Filtering the Host Inventory
        • Topology
          • Trying out the Topology Tools
          • Configuring Topology Viewing Preferences
      • Managing Devices
        • Using Tags
          • Working with Tags in Device Inventory
            • Creating Tags in the Device Inventory
            • Viewing and Applying Device Tags in the Device Inventory
            • Untagging Devices in the Device Inventory
          • Working with Tags in Topology View
            • Identifying Network Elements by Device Tag in Topology View
            • Creating and Applying a Device Tag on the Topology Page
            • Untagging Devices in Topology View
          • Deleting a Device Tag from the Available Tags List
        • Using Locations
          • Creating a Location in the Device Inventory
          • Viewing and Applying Locations in the Device Inventory
        • Tracing a Path
      • Prioritizing Network Traffic
        • Introduction to EasyQoS
        • Creating a Static QoS Policy
          • Creating Policy Scopes
          • Filtering Policy Scopes
          • Defining and Deploying Static QoS Policy
        • Creating a Dynamic QoS Policy
        • Editing a Policy Scope
        • Adding a New Packet Classifier
        • Customizing Existing Packet Classifiers
      • APIC-EM REST API
        • What is REST?
        • Introduction to the APIC-EM REST API
        • Installing an HTTP Client
        • Your First REST Request
        • Using the Online API Documentation
        • Access Controls
          • Groups and Roles
          • Group- and Role-Based Access Controls
        • Using Service Tickets
        • Managing Users and Roles Programmatically
          • Getting Users and Roles
          • Creating Users
          • Deleting Users
          • Updating User Account Information
        • Using ID Values in REST Requests
        • Getting Information About Asynchronous Operations
        • Discovering Devices and Hosts Programmatically
        • Additional REST API Activities
      • Next Steps
        • Experiment with RBAC Scopes
        • Observe GUI Use of the Northbound REST API
        • Watch APIC-EM REST API Video Tutorials
        • Experiment in Cisco DevNet Learning Labs
          • Accessing DevNet Learning Labs
        • Explore Additional Cisco APIC-EM Documentation
  • Reference
    • API Reference
    • FAQ
  • Downloads
    • Download APIC-EM Controller
  • Learn More
    • Product Features
  • Resources
    • Learning Labs
    • Sandbox
    • Blog
    • Forum
    • Support

Errata

This page provides late-breaking information about the versions of Cisco APIC-EM sandboxes and Cisco APIC-EM documentation that are available from DevNet.

Sandboxed Versions of the Cisco APIC-EM

Currently, DevNet sandboxes provide versions 1.3.x and 1.5.x of the Cisco APIC-EM controller:

  • Version 1.5.x is available in the Full HW Lab and the Hardware MiniLabs.
  • Version 1.3.x is available in the always-on sandbox and as a reservation-based database-only lab.

If you already know how to reserve and use sandbox labs, click for a list of APIC-EM sandboxes.

For more information about reserving and using sandbox labs, see the Logging in to the Cisco APIC-EM Controller section of Getting Started with Cisco APIC-EM.

Getting Started Guides

DevNet provides the following versions of the Getting Started with APIC-EM guide.

  • Getting Started with APIC-EM v. 1.5.x describes version 1.5.x of the APIC-EM controller. To work through this guide in a DevNet sandbox, use a hardware-backed lab, such as one of the Hardware Minilabs.

  • Getting Started with APIC-EM v. 1.4.x describes version 1.4.x of the APIC-EM controller. To work through this guide, you must use your own APIC-EM controller. DevNet sandboxes do not provide this version of the Cisco APIC-EM controller.

  • Getting Started with APIC-EM v. 1.3.x describes version 1.3.x of the APIC-EM controller. To work through this guide in a DevNet sandbox, use a database-only lab, such as the always-on sandbox or a Database-Only reservation-based sandbox.

You can use your own Cisco APIC-EM controller with any version of the Getting Started guide. For more information, see Using This Guide Outside of the DevNet Sandbox in Getting Started with APIC-EM. All GA versions of Cisco APIC-EM are available for download here.

API Documentation

Click here for Northbound REST API docs for all GA versions of Cisco APIC-EM. To change the API version being displayed, click APIC-EM Version and choose a version from the pull-down menu.

These static HTML docs do not provide a Try It Out button. To use the Try It Out feature to experiment interactively with APIC-EM REST APIs, you must log in to a live APIC-EM controller, such the one in the always-on sandbox, a reserved sandbox, or your own Cisco APIC-EM controller instance.

Updates

For information about updates to sandboxes or documentation, please revisit this page periodically.

Full HW Lab is Back!

Because there is only one Full HW lab, please avoid using this lab to work through the Getting Started guide. As a courtesy to your fellow developers, please try to use this lab only for software-development projects.