# Secrets

> SDK methods for the Secrets module, accessed via `soat.secrets`. See the [Secrets module docs](/docs/modules/secrets) for permissions and data model, and each method's REST page for the full request/response schema.

# Secrets

SDK methods for the Secrets module, accessed via `soat.secrets`. See the [Secrets module docs](/docs/modules/secrets) for permissions and data model, and each method's REST page for the full request/response schema.

### `soat.secrets.listSecrets()`

List secrets

- Method: `GET`
- Path: `/api/v1/secrets`

```ts
await soat.secrets.listSecrets({
  query: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/secrets/list-secrets)

### `soat.secrets.createSecret()`

Create a secret

- Method: `POST`
- Path: `/api/v1/secrets`

```ts
await soat.secrets.createSecret({
  body: { name, value, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/secrets/create-secret)

### `soat.secrets.getSecret()`

Get a secret

- Method: `GET`
- Path: `/api/v1/secrets/{secret_id}`

```ts
await soat.secrets.getSecret({
  path: { secret_id },
});
```

→ [Request & response schema](/docs/api/secrets/get-secret)

### `soat.secrets.updateSecret()`

Update a secret

- Method: `PATCH`
- Path: `/api/v1/secrets/{secret_id}`

```ts
await soat.secrets.updateSecret({
  path: { secret_id },
  body: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/secrets/update-secret)

### `soat.secrets.deleteSecret()`

Delete a secret

- Method: `DELETE`
- Path: `/api/v1/secrets/{secret_id}`

```ts
await soat.secrets.deleteSecret({
  path: { secret_id },
  query: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/secrets/delete-secret)