> Expert > Tools & Utilities > Developer Tools > REST API > REST API Reference > Key Management Server Operations

View Details of a Key Management Server (REST API: GET)

Updated

This operation returns the details of a key management server.

Request

Syntax

Send the request using either XML or JSON:

  • XML

    GET <webservice>/CommCell/KeyManagementServers/{keyProviderId}?propertyLevel={propertyLevel}&providerType={providerType}
HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

  • JSON

    GET <webservice>/CommCell/KeyManagementServers/{keyProviderId}?propertyLevel={propertyLevel}&providerType={providerType}
HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: <authentication token>

where <webservice> is the root path that routes the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

keyProviderId

The ID of the key management server.

Yes

propertyLevel

The amount of information to return for the key management server.

Valid values are:

  • 1, Return only the ID and name of the key management server.

  • 5, Return essential information about the key management server

  • 10, Return basic information about the key management server

  • 20, Return advanced information about the key management server

  • 30, Return complete information about the key management server

Yes

providerType

The provider type of the key management server.

Valid values are:

  • 1, Commvault

  • 2, Key Management Interoperability Protocol (KMIP)

  • 3, Amazon Web Services (AWS)

  • 4, Azure Key Vault

  • 5, SafeNet

  • 6, Passphrase

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or the Web Console that is used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token that you receive after successfully logging on. For information about receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

keyProviderType

The type of the key management server.

Valid values are:

  • 1, Commvault

  • 2, Key Management Interoperability Protocol (KMIP)

  • 3, Amazon Web Services (AWS)

  • 4, Azure Key Vault

  • 5, SafeNet

  • 6, Passphrase

keyProviders

keyProviderId

The ID of the key management server.

provider

keyProviderName

The name of the key management server.

provider

Examples

Sample Request

This request returns the details of a key management server.

XML

GET <webservice>/CommCell/KeyManagementServers/10?propertyLevel=1&providerType=3
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

JSON

GET <webservice>/CommCell/KeyManagementServers/10?propertyLevel=1&providerType=3
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{
    "keyProviders": [
        {
            "keyProviderType": 3,
            "provider": {
                "keyProviderId": 10,
                "keyProviderName": "AWS"
            }
        }
    ]
}