Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET cm/credentials

Deprecated

Do not use this resource. Credentials can be retrieved through API "GET-devices/exportDevices".

Operation to retrieve device credentials. Can take one of two parameters: 'id' or 'address'. , e.g. ?id=17010 or ?address=172.23.218.75, where the id is MEI ID or the address is the management address.

Since Product Version: 1.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Credential

HTTP Methods

GET

Resource URL

/webacs/api/v2/op/cm/credentials

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

id String

query

OptionalId is the MEI ID

address String

query

OptionalThe management address.

Response Parameters

Attribute Description

credentialList Arrow image PropertyNameAndStringValue[]

The map of credentials.

id String

This corresponds to the IP_ADDRESS field in the underlying credential class. In XMP this holds the MEI ID.

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Response Payload

https://localhost/webacs/api/v2/op/cm/credentials

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/cm/credentials" rootUrl="https://localhost/webacs/api/v2/op">
  <credentialDTO>
    <credentialList>
      <credentialList>
        <lazyLoadedEntities>
          <entry>
            <key>String value</key>
            <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
          </entry>
        </lazyLoadedEntities>
        <instanceId>2</instanceId>
        <instanceTenantId>15</instanceTenantId>
        <instanceUuid>String value</instanceUuid>
        <instanceVersion>1</instanceVersion>
        <propertyName>String value</propertyName>
        <stringValue>String value</stringValue>
      </credentialList>
    </credentialList>
    <id>String value</id>
  </credentialDTO>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v2/op/cm/credentials.json

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v2/op/cm/credentials",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v2/op",
    "credentialDTO" : [ {
      "credentialList" : {
        "credentialList" : [ {
          "propertyName" : "String value",
          "stringValue" : "String value"
        } ]
      },
      "id" : "String value"
    } ]
  }
}