67 lines
1.5 KiB
Markdown
67 lines
1.5 KiB
Markdown
---
|
|
name: hook-keys-routes
|
|
description: Handle 6 OpenAPI operation(s) under /api/v1/hook-keys for the hook keys route group.
|
|
---
|
|
|
|
# hook keys API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /api/v1/hook-keys for the hook keys 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
|
|
|
|
### list_hook_keys
|
|
|
|
- Operation ID: `list_hook_keys`
|
|
- Route: `GET /api/v1/hook-keys`
|
|
- Mode: READ
|
|
- Summary: List all keys
|
|
|
|
### create_hook_key
|
|
|
|
- Operation ID: `create_hook_key`
|
|
- Route: `POST /api/v1/hook-keys`
|
|
- Mode: WRITE
|
|
- Summary: Create a key
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_public_key
|
|
|
|
- Operation ID: `get_public_key`
|
|
- Route: `GET /api/v1/hook-keys/public/{keyId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a public key
|
|
- Parameters:
|
|
- `keyId` in `path` required
|
|
|
|
### get_hook_key
|
|
|
|
- Operation ID: `get_hook_key`
|
|
- Route: `GET /api/v1/hook-keys/{id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a key by ID
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### replace_hook_key
|
|
|
|
- Operation ID: `replace_hook_key`
|
|
- Route: `PUT /api/v1/hook-keys/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a key
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_hook_key
|
|
|
|
- Operation ID: `delete_hook_key`
|
|
- Route: `DELETE /api/v1/hook-keys/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a key
|
|
- Parameters:
|
|
- `id` in `path` required
|