Cisco Cisco Elastic Services Controller 2.3 Developer's Guide

Generic Syntax. See sections related to URI encoding, sections 2.2 Reserved Characters and 2.3
Unreserved Characters. ESC will accept an internal id specified in the request URL form the unreserved
character set: unreserved = ALPHA / DIGIT / "-" / "." / "_”

NOTE: the tilde “~” is not supported in the internal id character set.

The internal id received in a request must be unique within the scope of all the domain resources (tenant,
network, subnet, service catalog, deployment ) For example, you cannot create 2 networks with the same
internal_network_id, even if the networks are created under different tenants.

REST API Security

REST Authentication

Overview

ESC REST API uses http basic access authentication where the ESC client will have to provide a username
and password when making ESC REST requests. The user name and password will be encoded with
Base64 in transit, but not encrypted or hashed. HTTPS will be used in conjunction with Basic Authentication
to provide the encryption.

Setup

By default, the REST authentication is disabled. To enable it the pass the argument --enable-auth to ESC
bootvm.py, ESC installation script.

Username and Password

The REST interface has only one default username/password (admin/cisco123).

The REST password can be updated using escadm tool from the ESC VM CLI:

$ escadm rest set --username admin --password test123

The REST password can be reset using escadm tool from the ESC VM CLI:

$ escadm rest set

You can also update the password through the REST API:

Sending an Authorized Request

To send an authorized request an ESC client should send the request with the following header:

Authorization: Basic YWRtaW46Y2lzY28xMjM=