Base URI Format
The base URI format is https:// <host>:<port>/v1/ …
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:
- : Cisco provides the host name.
- : The client provides the host name based on the CloudCenter URI format.
See the CloudCenter Deployment Model section for the relevant release for additional content.
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.
Effective CloudCenter 4.6.0, the CloudCenter API version can be v1 or v2 as applicable. The possible versions are identified for each API, where applicable.
Attributes used to make the API call are displayed after the API requests and responses and called out as Request Attributes or Response Attributes depending on where they appear. Each attribute (or group of attributes) are identified by the blue header text. For example:
This is single attribute:
- Description: Unique (in the system) email address for this resource and must match the regular expression
- Type: String
This is group of attributes: