Docs Menu
Docs Home
/ /
Key Vault
Docs Home
/ /
Backup Administration
/
Key Vault
Docs Home
/
Management
/
Ops Manager
/
API
/
Resources
/
Backup Administration
/
Key Vault

Get All Key Vault Configurations

Retrieves the configurations of all key vaults.

Required Roles

You can successfully call this endpoint with any of the following assigned roles:

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin

Resource

GET /keyVault

Request Path Parameters

This endpoint doesn't use HTTP request path parameters.

Request Query Parameters

Name
Type
Necessity
Description
Default

pageNum

number

Optional

One-based integer that returns a subsection of results.

1

itemsPerPage

number

Optional

Number of items to return per page, up to a maximum of 500.

100

pretty

boolean

Optional

Flag that indicates whether the response body should be in a prettyprint format.

false

envelope

boolean

Optional

Flag that indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope : true in the query.

For endpoints that return a list of results, the content object is an envelope. Ops Manager adds the status field to the response body.

false

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name
Type
Description

results

array

Array includes one object for each item detailed in the results Embedded Document section.

links

array

Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.

totalCount

number

Integer count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document

Each result is one key vault configuration.

Name
Type
Description

id

string

Unique identifier that Ops Manager generates for this key vault configuration. Use this value as the vaultId when you configure an S3-compatible storage snapshot store to use this key vault.

friendlyName

string

Human-readable label that identifies this key vault configuration.

type

string

Key vault provider type. Ops Manager returns HASHI_CORP, which represents HashiCorp Vault.

url

string

Address of the HashiCorp Vault server that Ops Manager connects to.

auth

object

Authentication details that Ops Manager uses to connect to HashiCorp Vault.

auth.mechanism

string

Authentication method that Ops Manager uses to connect to HashiCorp Vault. Ops Manager returns one of the following values:

  • TOKEN

  • JWT

auth.secret

string

Credential that Ops Manager uses to authenticate to HashiCorp Vault. Ops Manager encrypts this value at rest and returns [REDACTED] instead of the stored value.

auth.jwtClaims

object

Claims that Ops Manager sends when it requests a JWT login from HashiCorp Vault. Ops Manager returns this object only when auth.mechanism is JWT.

customCertificates

array

List of custom Certificate Authority certificates that Ops Manager uses for TLS verification when it connects to the HashiCorp Vault server.

customCertificates[n].filename

string

Name that identifies the Certificate Authority PEM file.

customCertificates[n].certString

string

Contents of the Certificate Authority PEM file. Ops Manager returns [REDACTED] instead of the stored value.

links

object array

One or more links to sub-resources or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.

Example Request

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true'

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

{
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true&pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "id": "{KEY-VAULT-ID}",
      "friendlyName": "myVault",
      "type": "HASHI_CORP",
      "url": "https://localhost:8200/",
      "auth": {
        "mechanism": "TOKEN",
        "secret": "[REDACTED]"
      },
      "links": [
        {
          "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault/{KEY-VAULT-ID}",
          "rel": "self"
        }
      ]
    }
  ],
  "totalCount": 1
}

Back

Get by ID

Next

Create

On this page