Cisco Cisco UCS Director 5.4 Developer's Guide

You must pass the REST API access key as a name:value header following standard HTTP syntax and semantic
rules. For example, a valid name:value header is X-Cloupia-Request-Key:
F90ZZF12345678ZZ90Z12ZZ3456FZ789. For more information about the API request header, see

Make a REST API Request, on page 10

and

Header Field Definitions.

The REST API call can be made in one of the following ways:

• Cisco UCS Director GUI—Cisco UCS Director provides a developer menu option to offer the report

metadata and REST API Browser for developers. To access these features, enable the developer menu.
For more information about how to enable the developer menu, see

Options, on page 6

.

On enabling the developer menu, you gain access to the following features:

◦Report Metadata— Report Metadata enables you to view the REST API URL for every report

displayed in Cisco UCS Director. For more information about how to access Report Metadata, see

Accessing the Report Metadata, on page 7

.

◦REST API Browser—The REST API Browser is accessible from the Orchestration menu of Cisco

UCS Director. The REST API Browser provides API information and API code generation
capabilities that make it easy to see and work with all the available APIs, including both the REST
APIs and the Java APIs. For more information about how to access REST API Browser, see

the REST API Browser, on page 7

.

• REST Client—The REST Client is a useful widget for parsing and viewing API requests and responses.

In this widget, you can enter a REST URL and apply an HTTP method such as POST, PUT, or DELETE
to the URL for data manipulation. The REST Client provides a simple user interface for entering an
URL to fetch data from the Cisco UCS Director server.

• If you are using Mozilla Firefox, download RESTClient from

• If you are using Google Chrome, download Advanced REST Client from the

.

If you are logged into Cisco UCS Director, use any supported web browser to send API
requests and get responses.

• Code— The Sample Java Code tab of the REST API Browser tab provides a code snippet that can

be used to automate the management services.

The Cisco UCS Director SDK binary downloaded from the

area or the

site

includes a sample project that can be used as a platform for executing client code.

Before you start using the Cisco UCS Director SDK, make sure that:

• Cisco UCS Director is installed and running on your system. For more information about how to install

Cisco UCS Director, refer the

.

• The Cisco UCS Director SDK is installed on your system.

• You have Java Version 1.8 for your Java development environment.