# Secrets Commands

> See [Secrets module docs](../../modules/secrets) for permissions and data model.

# Secrets Commands

See [Secrets module docs](../../modules/secrets) for permissions and data model.

### `soat list-secrets`

List secrets

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

#### Usage

```bash
soat list-secrets
```

#### Options

##### `--project-id`

Project ID (required if not using project key auth)

- Source: `query`
- Required: no
- Type: `string`
- Example: `proj_V1StGXR8Z5jdHi6B`

##### `--limit`

Number of results per page

- Source: `query`
- Required: no
- Type: `integer`
- Default: `25`

##### `--offset`

Number of results to skip

- Source: `query`
- Required: no
- Type: `integer`
- Default: `0`

### `soat create-secret`

Create a secret

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

#### Usage

```bash
soat create-secret --name <string> --value <string>
```

#### Options

##### `--project-id`

Project ID (required if not using project key auth)

- Source: `body`
- Required: no
- Type: `string`
- Example: `proj_V1StGXR8Z5jdHi6B`

##### `--name`

Secret name

- Source: `body`
- Required: yes
- Type: `string`
- Example: `DATABASE_PASSWORD`

##### `--value`

Secret value (will be encrypted)

- Source: `body`
- Required: yes
- Type: `string`
- Example: `supersecretpassword`

### `soat get-secret`

Get a secret

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

#### Usage

```bash
soat get-secret --secret-id <string>
```

#### Options

##### `--secret-id`

Secret ID

- Source: `path`
- Required: yes
- Type: `string`
- Example: `sec_V1StGXR8Z5jdHi6B`

### `soat update-secret`

Update a secret

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

#### Usage

```bash
soat update-secret --secret-id <string>
```

#### Options

##### `--secret-id`

Secret ID

- Source: `path`
- Required: yes
- Type: `string`

##### `--name`

New secret name

- Source: `body`
- Required: no
- Type: `string`

##### `--value`

New secret value

- Source: `body`
- Required: no
- Type: `string`

### `soat delete-secret`

Delete a secret

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

#### Usage

```bash
soat delete-secret --secret-id <string>
```

#### Options

##### `--secret-id`

Secret ID

- Source: `path`
- Required: yes
- Type: `string`