
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# GET cm/credentials

Deprecated

Do not use this resource. Credentials can be retrieved through API Export Devices.

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

- Jump To

- v1
- v2
- v3
- v4

### 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

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/op/cm/credentials

## Request Parameters

Attribute | Source | Description
--- | --- | ---
id String | query | Optional Id is the MEI ID
address String | query | Optional The management address.

## Response Parameters

Attribute | Description
--- | ---
credentialList PropertyNameAndStringValue[] | The map of credentials.
Attribute | Description
--- | ---
propertyName String |
stringValue String |
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://172.20.127.108/webacs/api/v1/op/cm/credentials

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v1/op">
      <credentialDTO>
        <credentialList>
          <credentialList>
            <lazyLoadedEntities>
              <entry>
                <key>Another 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">Another string value</value>
              </entry>
              <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>
            <instanceUuid>String value</instanceUuid>
            <instanceVersion>1</instanceVersion>
            <propertyName>String value</propertyName>
            <stringValue>String value</stringValue>
          </credentialList>
          <credentialList>
            <lazyLoadedEntities>
              <entry>
                <key>Another 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">Another string value</value>
              </entry>
              <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>12</instanceId>
            <instanceUuid>Another string value</instanceUuid>
            <instanceVersion>11</instanceVersion>
            <propertyName>Another string value</propertyName>
            <stringValue>Another string value</stringValue>
          </credentialList>
        </credentialList>
        <id>String value</id>
      </credentialDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v1/op/cm/credentials.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/cm\/credentials",
        "@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op",
        "credentialDTO" : {
          "credentialList" : {
            "credentialList" : [{
              "lazyLoadedEntities" : {
                "entry" : [{
                  "key" : "Another string value",
                  "value" : {
                    "@xsi.type" : "xs : string",
                    "$" : "Another string value"
                  }
                },
                {
                  "key" : "String value",
                  "value" : {
                    "@xsi.type" : "xs : string",
                    "$" : "String value"
                  }
                }]
              },
              "instanceId" : 2,
              "instanceUuid" : "String value",
              "instanceVersion" : 1,
              "propertyName" : "String value",
              "stringValue" : "String value"
            },
            {
              "lazyLoadedEntities" : {
                "entry" : [{
                  "key" : "Another string value",
                  "value" : {
                    "@xsi.type" : "xs : string",
                    "$" : "Another string value"
                  }
                },
                {
                  "key" : "String value",
                  "value" : {
                    "@xsi.type" : "xs : string",
                    "$" : "String value"
                  }
                }]
              },
              "instanceId" : 12,
              "instanceUuid" : "Another string value",
              "instanceVersion" : 11,
              "propertyName" : "Another string value",
              "stringValue" : "Another string value"
            }]
          },
          "id" : "String value"
        }
      }
    }

### 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 | Optional Id is the MEI ID
address String | query | Optional The management address.

## Response Parameters

Attribute | Description
--- | ---
credentialList PropertyNameAndStringValue[] | The map of credentials.
Attribute | Description
--- | ---
propertyName String |
stringValue String |
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://172.20.127.108/webacs/api/v2/op/cm/credentials

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/op">
      <credentialDTO>
        <credentialList>
          <credentialList>
            <lazyLoadedEntities>
              <entry>
                <key>Another 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">Another string value</value>
              </entry>
              <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>
            <instanceUuid>String value</instanceUuid>
            <instanceVersion>1</instanceVersion>
            <propertyName>String value</propertyName>
            <stringValue>String value</stringValue>
          </credentialList>
          <credentialList>
            <lazyLoadedEntities>
              <entry>
                <key>Another 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">Another string value</value>
              </entry>
              <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>12</instanceId>
            <instanceUuid>Another string value</instanceUuid>
            <instanceVersion>11</instanceVersion>
            <propertyName>Another string value</propertyName>
            <stringValue>Another string value</stringValue>
          </credentialList>
        </credentialList>
        <id>String value</id>
      </credentialDTO>
    </mgmtResponse>

### Sample JSON Response Payload

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

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
        "credentialDTO" : [ {
          "credentialList" : {
            "credentialList" : [ {
              "propertyName" : "String value",
              "stringValue" : "String value"
            }, {
              "propertyName" : "Another string value",
              "stringValue" : "Another string value"
            } ]
          },
          "id" : "String value"
        } ]
      }
    }

### 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/v3/op/cm/credentials

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
id String | query | Optional Id is the MEI ID
address String | query | Optional The management address.

## Response Parameters

Attribute | Description
--- | ---
credentialList PropertyNameAndStringValue[] | The map of credentials.
Attribute | Description
--- | ---
propertyName String |
stringValue String |
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://172.20.127.108/webacs/api/v3/op/cm/credentials

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v3/op">
      <credentialDTO>
        <credentialList>
          <credentialList>
            <lazyLoadedEntities>
              <entry>
                <key>Another 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">Another string value</value>
              </entry>
              <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>
            <instanceUuid>String value</instanceUuid>
            <instanceVersion>1</instanceVersion>
            <propertyName>String value</propertyName>
            <stringValue>String value</stringValue>
          </credentialList>
          <credentialList>
            <lazyLoadedEntities>
              <entry>
                <key>Another 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">Another string value</value>
              </entry>
              <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>12</instanceId>
            <instanceUuid>Another string value</instanceUuid>
            <instanceVersion>11</instanceVersion>
            <propertyName>Another string value</propertyName>
            <stringValue>Another string value</stringValue>
          </credentialList>
        </credentialList>
        <id>String value</id>
      </credentialDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://172.20.127.108/webacs/api/v3/op/cm/credentials.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v3/op",
        "credentialDTO" : [ {
          "credentialList" : {
            "credentialList" : [ {
              "propertyName" : "String value",
              "stringValue" : "String value"
            }, {
              "propertyName" : "Another string value",
              "stringValue" : "Another string value"
            } ]
          },
          "id" : "String value"
        } ]
      }
    }

Resource unavailable for this API version

This resource was removed in API version 4.