Base URI Format


The base URI format is https:// <host>:<port>/

Host Name

The host is generally represented as <HOST> in all CloudCenter APIs. It represents the IP address or the DNS name.

The host differs based on your DNS or IP address and port usage.

Port Usage

The port is generally represented at <PORT> in all CloudCenter APIs. It represents the port used to connect to the CCO server for the API connection. The <PORT> in the REST endpoint is optional. You can decide if you want to use the port for each API call. All CloudCenter API requests and responses display <PORT> in all examples.

curl -H "Accept:application/json" -H "Content-Type:application/json" -u \
cloudcenteradmin:40E45DBE57E35ECB -X GET https://<HOST>:<PORT>/...

API Version

The CloudCenter Suite 5.0.0 API version can be v1 or v2 as applicable. The version is identified for each API, where applicable.

Parameters

Parameters used to make the API call are displayed after the APIs and are called out after the description.

Parameter Types

Attribute TypeDescription
StringAny combination of characters. Maximum of 255 characters.
IntegerA whole number value. Restricted to 32-bit values.
LongA whole number value. Restricted to 64-bit values.
FloatA number with or without a decimal point. Displayed as a string in the response.
BooleanA logical true or false value. May be passed to API requests as true or false or 1 or 0.
EnumerationA predefined list of values, for example STANDARD or TENANT describes the possible values for each type. Only listed values are permitted, other values result in an error.
JSON Object

A method to parse JavaScript Object Notation (JSON) and return the object value to which a specified name is mapped.

Name-Value Pair

A name–value pair where each element is an attribute–value pair.

ArrayA sequential collection of like elements corresponding to the element's data type. The type of the array is determined by the types of the elements (can be String, Integer, Name-Value Pair Type)

Perms List

Lists the permissions for specific user if the user is logged in. An empty response is also indicative of the resource not being currently supported.
MetadataMetadata information associated with the cloud provider.





  • No labels
© 2017-2019 Cisco Systems, Inc. All rights reserved