117 lines
3.1 KiB
Markdown
117 lines
3.1 KiB
Markdown
---
|
|
name: vault-routes
|
|
description: Handle 11 OpenAPI operation(s) under /vault/v1 for the vault route group.
|
|
---
|
|
|
|
# vault API Routes
|
|
|
|
Handle 11 OpenAPI operation(s) under /vault/v1 for the vault route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### jump_wire_web_key_controller_create_data_key
|
|
|
|
- Operation ID: `jump_wire_web_key_controller_create_data_key`
|
|
- Route: `POST /vault/v1/keys/data-key`
|
|
- Mode: WRITE
|
|
- Summary: Create a data key
|
|
- Body: JSON request body accepted.
|
|
|
|
### jump_wire_web_key_controller_decrypt
|
|
|
|
- Operation ID: `jump_wire_web_key_controller_decrypt`
|
|
- Route: `POST /vault/v1/keys/decrypt`
|
|
- Mode: WRITE
|
|
- Summary: Decrypt a data key
|
|
- Body: JSON request body accepted.
|
|
|
|
### jump_wire_web_key_controller_rekey
|
|
|
|
- Operation ID: `jump_wire_web_key_controller_rekey`
|
|
- Route: `POST /vault/v1/keys/rekey`
|
|
- Mode: WRITE
|
|
- Summary: Re-encrypt a data key
|
|
- Body: JSON request body accepted.
|
|
|
|
### jump_wire_web_data_vault_controller_index
|
|
|
|
- Operation ID: `jump_wire_web_data_vault_controller_index`
|
|
- Route: `GET /vault/v1/kv`
|
|
- Mode: READ
|
|
- Summary: List objects
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `before` in `query`
|
|
- `after` in `query`
|
|
- `order` in `query`
|
|
- `search` in `query`
|
|
- `updatedAfter` in `query`
|
|
|
|
### jump_wire_web_data_vault_controller_create
|
|
|
|
- Operation ID: `jump_wire_web_data_vault_controller_create`
|
|
- Route: `POST /vault/v1/kv`
|
|
- Mode: WRITE
|
|
- Summary: Create an object
|
|
- Body: JSON request body accepted.
|
|
|
|
### jump_wire_web_data_vault_controller_show_by_name
|
|
|
|
- Operation ID: `jump_wire_web_data_vault_controller_show_by_name`
|
|
- Route: `GET /vault/v1/kv/name/{name}`
|
|
- Mode: READ
|
|
- Summary: Read an object by name
|
|
- Parameters:
|
|
- `name` in `path` required
|
|
|
|
### jump_wire_web_data_vault_controller_delete
|
|
|
|
- Operation ID: `jump_wire_web_data_vault_controller_delete`
|
|
- Route: `DELETE /vault/v1/kv/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an object
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `version_check` in `query`
|
|
|
|
### jump_wire_web_data_vault_controller_show_by_id
|
|
|
|
- Operation ID: `jump_wire_web_data_vault_controller_show_by_id`
|
|
- Route: `GET /vault/v1/kv/{id}`
|
|
- Mode: READ
|
|
- Summary: Read an object by ID
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### jump_wire_web_data_vault_controller_update
|
|
|
|
- Operation ID: `jump_wire_web_data_vault_controller_update`
|
|
- Route: `PUT /vault/v1/kv/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update an object
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### jump_wire_web_data_vault_controller_describe
|
|
|
|
- Operation ID: `jump_wire_web_data_vault_controller_describe`
|
|
- Route: `GET /vault/v1/kv/{id}/metadata`
|
|
- Mode: READ
|
|
- Summary: Describe an object
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### jump_wire_web_data_vault_controller_versions
|
|
|
|
- Operation ID: `jump_wire_web_data_vault_controller_versions`
|
|
- Route: `GET /vault/v1/kv/{id}/versions`
|
|
- Mode: READ
|
|
- Summary: List object versions
|
|
- Parameters:
|
|
- `id` in `path` required
|