---
title: "Secrets hooks"
description: "Hand-written shim. Implementation is generated; see ./secrets.gen."
section: "Libraries"
group: "React hooks"
order: 445
---

## Hooks

### `useCreateSecret` `mutation`

Create a secret. The value is encrypted at rest and never returned.

```ts
useCreateSecret(options?: MutationOpts<Secret, CreateSecretParams>)
```

**Types:** [Secret](/types/secret) · [CreateSecretParams](/types/create-secret-params)

### `useDeleteSecret` `mutation`

Soft-delete a secret.

```ts
useDeleteSecret(options?: MutationOpts<SuccessResponse, string>)
```

**Types:** [SuccessResponse](/types/success-response)

### `useListSecrets` `query`

List secrets with pagination. Values are never returned.

```ts
useListSecrets(params?: Omit<ListSecretsParams, | > & { filter?: SecretFilter; orderBy?: SecretOrderBy[]; } & SecretShorthands, options?: QueryOpts<Page<Secret>>)
```

**Types:** [ListSecretsParams](/types/list-secrets-params) · [SecretFilter](/types/secret-filter) · [SecretOrderBy](/types/secret-order-by) · [SecretShorthands](/types/secret-shorthands) · [Page](/types/page) · [Secret](/types/secret)

### `usePurgeSecret` `composite`

Permanently delete a soft-deleted secret (erasure — removes the ciphertext).

```ts
usePurgeSecret(options?: MutationOpts<SuccessResponse, PurgeSecretParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [PurgeSecretParams](/types/purge-secret-params)

### `useRestoreSecret` `composite`

Restore a soft-deleted secret.

```ts
useRestoreSecret(options?: MutationOpts<Secret, string>)
```

**Types:** [Secret](/types/secret)

### `useRetrieveSecret` `query`

Get a single secret by ID (metadata only — never the value).

```ts
useRetrieveSecret(id: string, options?: QueryOpts<Secret>)
```

**Types:** [Secret](/types/secret)

### `useUpdateSecret` `mutation`

Update a secret's name, value, or metadata.

```ts
useUpdateSecret(options?: MutationOpts<Secret, UpdateSecretParams>)
```

**Types:** [Secret](/types/secret) · [UpdateSecretParams](/types/update-secret-params)