Set the Vault Configuration

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Connects the vault to the JFrog Platform to use signing keys stored in the vault.

Note: Requires TLS enabled.

Since: 7.17.4

Security: Requires an admin user

Usage: PUT /access/api/v1/vault/configs/hashicorp

Consumes: application/json

Sample Usage- Authentication Type Certificate

{
  "type": "HashicorpVault",
  "config": {
    "url": "https://my-value.acme.org",
    "auth": {
      "type": "Certificate",
      "certificate": "<PEM FORMAT>",
      "certificateKey": "<PEM FORMAT>"
    },
    "mounts":[
      {
        "path": "my-secrets",
        "type": "kv-v1"
      }
    ]
  }
}

Sample Usage- Authentication Type AppRole

{
  "type": "HashiCorpVault",
  "config": {
    "url": "https://my-value.acme.org",
    "auth": {
      "type": "AppRole",
      "roleId": "....",
      "secretId": "..."
    },
    "mounts":[
      {
        "path": "my-secrets",
        "type": "KV1"
      }
    ]
  }
}

Sample Usage- Authentication Type Agent (Self-Hosted only)

{
  "type": "HashiCorpVault",
  "config": {
    "url": "https://my-value.acme.org",
    "auth": {
      "type": "Agent"
    },
    "mounts":[
      {
        "path": "my-secrets",
        "type": "KV1"
      }
    ]
  }
}

Response Codes:

  • 400: Invalid input, e.g. unsupported secret manager type, auth type, missing auth, etc.

  • 401 / 403: Unauthenticated or unauthorized

  • 409: Conflict, e.g. TLS is disabled