Configure a new Hashicorp Vault

Request

Security

ApiKeyAuth

Bodyapplication/jsonrequired

env_variablesobject

Environment variables to set when invoking the Vault CLI tool. The environment variables will be used both to login to the vault (if this step is required) and to retrieve engine username and passwords.

Example:

{
  "VAULT_ADDR": "https://vault.company.co:8200",
  "VAULT_TOKEN": "token-to-retrieve-secrets"
}

login_command_argsArray of strings, [ 1 .. 100 ] items

Arguments to the "vault" CLI tool to be used to fetch a client token (or "login"). If supporting files, such as TLS certificates, must be used to authenticate, they can be mounted to the /etc/config directory. This property must not be set when using the TOKEN authentication method as login is not required.

Example:

[
  "login",
  "-method=cert",
  "-client-cert=/etc/config/cert.pem",
  "-client-key=/etc/config/key.pem",
  "write",
  "auth/approle/login",
  "role_id=123",
  "secret_id=456"
]

tagsArray of objects(Tag)

curl -i -X POST \
  https://help-api.delphix.com/_mock/data-control-tower/continuous-data/23.0.0/continuous-data-apis-dct-23.0.0/management/vaults/hashicorp \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "env_variables": {
      "VAULT_ADDR": "https://vault.company.co:8200",
      "VAULT_TOKEN": "token-to-retrieve-secrets"
    },
    "login_command_args": [
      "login",
      "-method=cert",
      "-client-cert=/etc/config/cert.pem",
      "-client-key=/etc/config/key.pem",
      "write",
      "auth/approle/login",
      "role_id=123",
      "secret_id=456"
    ],
    "tags": [
      {
        "key": "key-1",
        "value": "value-1"
      }
    ]
  }'

Responses

Created

Bodyapplication/json

idinteger, (int64)read-only

env_variablesobject

Environment variables to set when invoking the Vault CLI tool. The environment variables will be used both to login to the vault (if this step is required) and to retrieve engine username and passwords.

Example:

{
  "VAULT_ADDR": "https://vault.company.co:8200",
  "VAULT_TOKEN": "token-to-retrieve-secrets"
}

login_command_argsArray of strings, [ 1 .. 100 ] items

Arguments to the "vault" CLI tool to be used to fetch a client token (or "login"). If supporting files, such as TLS certificates, must be used to authenticate, they can be mounted to the /etc/config directory. This property must not be set when using the TOKEN authentication method as login is not required.

Example:

[
  "login",
  "-method=cert",
  "-client-cert=/etc/config/cert.pem",
  "-client-key=/etc/config/key.pem",
  "write",
  "auth/approle/login",
  "role_id=123",
  "secret_id=456"
]

tagsArray of objects(Tag)

Response

{
  "id": 0,
  "env_variables": {
    "VAULT_ADDR": "https://vault.company.co:8200",
    "VAULT_TOKEN": "token-to-retrieve-secrets"
  },
  "login_command_args": [
    "login",
    "-method=cert",
    "-client-cert=/etc/config/cert.pem",
    "-client-key=/etc/config/key.pem",
    "write",
    "auth/approle/login",
    "role_id=123",
    "secret_id=456"
  ],
  "tags": [
    { … }
  ]
}