Enabling REST API Support Using the Cisco IOS XE CLI
Introduction to REST API Configuration Options
You need to configure the management interface to support REST API using the Cisco IOS XE CLI if you
installed the Cisco CSR 1000v in either of the following ways:
•
If you installed the Cisco CSR 1000v using the .iso file.
•
If you deployed the Cisco CSR 1000v using an Amazon Machine Image (AMI).
If upgrading a REST API configuration from Cisco IOS XE Release 3.10S to a later release, you must
add your REST API configuration to the IOS configuration.
Note
Before configuring the shared management interface, perform the steps in
page 277
.
The REST API management is located in a management virtual services container that is separate from the
router components, including the router management interface. You have two choices for configuring the
REST API management support, and the steps for each of these are in the following two sections:
•
Configuring the Shared Management Interface to Support the REST API , on page 279
(Cisco IOS XE 3.13S and later, and IOS XE Denali 16.3 and later) The router management interface
and the virtual services management container can share the same IP address. This can be used to save
an IP address to be allocated for other purposes.
•
Configuring the Dual Management Interface to Support the REST API , on page 281
(Required in Cisco IOS XE 3.11S and 3.12S, optional in later releases.) The router management interface
and the virtual services management container use different IP addresses.
The remainder of this section contains information about:
•
Configuring the REST API Local Port and AutoSave Options, on page 283
•
Configuring HTTPS Support for the REST API Using the Cisco IOS XE CLI, on page 284
•
Disabling REST API Support, on page 285
•
Viewing the REST API Container Status, on page 287
Enabling REST API Support
Beginning with Cisco IOS XE Release 3.11S, and including IOS XE Denali 16.3.1 and later, you can enable
REST API support on the remote management interface. To disable REST API support, see
API Support, on page 285
. To enable the REST API, perform the following steps.
Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide
277
Enabling Management by REST API
Enabling REST API Support Using the Cisco IOS XE CLI