---
title: "Test Azure Key Vault Connection"
method: POST
path: "/v0/azure-key-vault/accounts/{account-id}/test"
tags: ["Azure Key Vault Accounts"]
---

# Test Azure Key Vault Connection

`POST /v0/azure-key-vault/accounts/{account-id}/test`

Test that OneSchema can authenticate via the configured App Registration and retrieve a specific secret. The secret value is not returned.

## Path parameters

- `account-id` integer, required

## Request body

- AzureTestConnectionRequest
  - `secret_identifier` string, required — The identifier of the secret to test retrieval for
  - `vault` string, required — The full Azure Key Vault URL (e.g. https://myvault.vault.azure.net)
  - `secret_version` string, nullable — A specific version to test (omit for latest)

## Response `200`

Test result (check the `success` field)

- TestConnectionResponse
  - `success` boolean
  - `error_code` string — Present when success is false
  - `error_category` 'account' | 'secret' | 'provider' — Broad classification of the failure. "account" means the account credentials or permissions are wrong; "secret" means the secret identifier or version could not be found; "provider" means a transient infrastructure issue. Present when success is false.
  - `error_message` string — Present when success is false
  - `request_id` string
  - `transaction_id` string

## Other responses

- `401` — Unauthorized (missing or invalid API key)
- `403` — Forbidden
- `404` — Not found

---

[API](https://skmtc.net/oneschema/apis/templates.md) · [All operations](https://skmtc.net/oneschema/apis/templates/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneschema/templates/revisions/40674aa6d4d9/schema)