CliQr is now part of Cisco Learn More About Cisco

View Extension

Details

API Details
NameView Extension(s)
Description

Displays information for all Extensions or for a specified extension.

MethodGET
URI
  • v1/extensions 
  • v1/extensions/aci
  • v1/extensions/aci/extensionId
  • v1/extensions/aci/properties?regionName=regionName&propertyType=propertyType&extensionId=extensionId
  • v1/extensions/aci/properties?regionName=regionName&propertyType=propertyType&extensionId=extensionId&tenantName=tenantName
CloudCenter Release

Introduced in CloudCenter 4.6.0.

Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.
  • The password parameter is displayed in clear text for users with write or admin access. For all other users, the CloudCenter platform displays ===redacted=== in the password attribute.
ESB Header
  • action: get.extensions 
  • action: get.extensions.aci 
  • action: get.extensions.aci.extensionId
  • action: get.extensions.aci 
    actionparam: regionName=regionName&propertyType=propertyType&extensionId=extensionId
  • action: get.extensions.aci
    actionparam:  regionName=regionName&propertyType=propertyType&extensionId=extensionId&tenantName=tenantName

Example 1 – v1/extensions

Response

Example 2 – v1/extensions/aci

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/extensions/aci"

Response

 

Example 3 –  v1/extensions/aci/extensionId

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/extensions/aci/8"

Response

 Example 4 – v1/extensions/aci/properties?regionName=regionName&propertyType=propertyType&extensionId=extensionId

Response

Example 5 – v1/extensions/aci/properties?regionName=regionName&propertyType=propertyType&extensionId=extensionId&tenantName=tenantName

Response

Request Attributes

extensionId
  • DescriptionUnique, system-generated identifier for the extension. See Extensions for additional details.
  • Type: String

regionName
  • DescriptionThe name of this cloud region as listed in Public Clouds.
  • Type: String

Optional query parameter

propertyType
  • Description: The property type for this extension that is used to fetch different API properties.
    • bridgedomains
    • epgs
    • l3outs
    • tenants
    • vrfs
    • mms
    • servicegraphtemplates
  • Type: String

Optional query parameter

tenantName
  • Description: The name of the tenant for which the details are identified in this report. See Sub-Tenant Configuration  > Tenant ID and Tenant Name Dependency.

  • Type: String

Optional query parameter

Response Attributes

extensions (click for additional details)

aciExtensions (click for additional details)

perms (click for additional details)
id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource
  • Type: String
aciConnectionInfo
  • Description: Identifies the information for the APIC endpoint.
  • Type: Sequence of details about this ACI type

    apicEndpoint
    • Description: The URL for the Cisco Application Policy Infrastructure Controller (Cisco APIC) endpoint.
    • Type: String
    username
    • Description: Unique, CloudCenter-generated name reference for this user.
    • Type: String
    password
    • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
    • Type: String
     connectingCloudType 
    • Description: The CCO cloud used to manage the APIC endpoint.
    • Type: String
bdTemplates (click for additional details)
extensionType
  • Description: Identifies the type of extension on the CloudCenter platform. 
  • Type: Enumeration

    EnumerationDescription
    ACI Identifies this extension as an ACI resource. See ACI for additional context.
    --No other extensions are currently available. See Extensions for additional context.
name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String
 ownerUserId 
  • DescriptionUnique, system-generated identifier for the owner of the tenant to which this service owner belongs
  • Type: String
endpoint
  • Description: The URL of the APIC device that is connected to the network directly or indirectly.
  • Type: String