Cisco Cisco UCS Director 5.4 Developer's Guide

First Published: November 03, 2015

Last Modified: June 30, 2016

The Cisco UCS Director REST API allows an application to interact with Cisco UCS Director programmatically.
These requests provide access to resources in Cisco UCS Director. With an API call, you can execute Cisco
UCS Director workflows and make changes to the configuration of switches, adapters, policies, and other
hardware and software components.

The API accepts and returns HTTP messages that contain JavaScript Object Notation (JSON) or Extensible
Markup Language (XML) documents. The JSON or XML payload contained in an HTTP message describes
a method or managed object (MO) in Cisco UCS Director. You can use any programming language to generate
the messages and the JSON or XML payload.

In RESTful APIs, the HTTP method specifies the action you want to perform and the URI specifies the
resource you want to access.

REST API uses the following HTTP methods to perform create, read, update, and delete (CRUD) operations:

Retrieves the specified resource . GET is a read-only
operation that does not change the engine state.

• The HTTP GET operation should not have a

request body. If information is passed in a GET
request, query parameters must be used instead.

• Unless specified, the HTTP GET operation

returns the configured state. For example, an
HTTP GET operation of the global routing table
returns the dynamic run-time state.

GET