Base URI Format

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

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 Deployment Model:

  • Cisco-Hosted Deployments: Cisco provides the host name.
  • Customer-Hosted Deployments: The client provides the host name based on the CloudCenter URI format.

Port Name

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>/v1/users

API Version

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.

Attribute(s)

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:

emailAddr
  • Description: Unique (in the system) email address for this resource and must match the regular expression
  • Type: String

This is group of attributes:

contractId
  • DescriptionUnique, system-generated identifier for a contract belonging to this tenant.
  • Type: String
bundleId
  • Description: Unique, system-generated identifier for the bundle belonging to this tenant.
  • Type: String
planId 
  • DescriptionUnique, system-generated identifier for the plan belonging to this tenant. The default is Null.
  • Type: String
activateRegions
  • Description: Cannot be an empty array, needs to have at least one entry in the array with a valid cloud region's regionId value.
  • Type: Array of key-value pairs (of type map)

    regionId
    • DescriptionUnique, system-generated identifier for the cloud region 
    • Type: String

Required.

agreeToContract
  • Description: Indicates whether the user has agreed to the tenant organization contract.

    • true = The user has agreed to the tenant organization contract 
    • false = Default. The user has not agreed to the tenant organization contract
  • Type: Boolean

importApps
  • Description: Array of unique identifiers for applications from the tenant Marketplace that will be made available to this user on activation. The default is an empty array.
  • Type: String (array)
sendActivationEmail
  • Description: Indicates whether the system sends an email message to the activated user.

    • true = The system sends an email message on user activation
    • false = Default. The system does not send an email message on user activation
  • Type: Boolean