Vault
4 methods on the Vault resource.
4 methods · 0 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";4 of 4
deleteVaultSecret
Delete one vault secret
compozy.vault.deleteVaultSecret({ query }) → Promise<void>
Options
- refstringqueryrequired
- Vault ref
DELETE /api/vault/secretsapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.vault.deleteVaultSecret({ query: { "ref": "ref" } });getVaultSecretMetadata
Read redacted vault secret metadata
compozy.vault.getVaultSecretMetadata({ query }) → Promise<VaultSecretResponse>
Options
- refstringqueryrequired
- Vault ref
GET /api/vault/secrets/metadataapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.vault.getVaultSecretMetadata({ query: { "ref": "ref" } });listVaultSecrets
List redacted vault secret metadata
compozy.vault.listVaultSecrets({ query }) → Promise<VaultSecretsResponse>
Options
- prefixstringquery
- Filter by vault ref prefix
- namespacestringquery
- Filter by vault namespace
GET /api/vault/secretsapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.vault.listVaultSecrets();putVaultSecret
Create or update one write-only vault secret
compozy.vault.putVaultSecret({ body }) → Promise<VaultSecretResponse>
Request bodyPutVaultSecretRequest
PUT /api/vault/secretsapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.vault.putVaultSecret({ body: { /* request fields */ } });