57 lines
1.5 KiB
Markdown
57 lines
1.5 KiB
Markdown
---
|
|
name: api-tokens-routes
|
|
description: Handle 5 OpenAPI operation(s) under /api/v1/api-tokens for the api tokens route group.
|
|
---
|
|
|
|
# api tokens API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /api/v1/api-tokens for the api tokens 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_api_tokens
|
|
|
|
- Operation ID: `list_api_tokens`
|
|
- Route: `GET /api/v1/api-tokens`
|
|
- Mode: READ
|
|
- Summary: List all API token metadata
|
|
|
|
### revoke_current_api_token
|
|
|
|
- Operation ID: `revoke_current_api_token`
|
|
- Route: `DELETE /api/v1/api-tokens/current`
|
|
- Mode: WRITE
|
|
- Summary: Revoke the current API token
|
|
|
|
### get_api_token
|
|
|
|
- Operation ID: `get_api_token`
|
|
- Route: `GET /api/v1/api-tokens/{apiTokenId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an API token's metadata
|
|
- Parameters:
|
|
- `apiTokenId` in `path` required
|
|
|
|
### upsert_api_token
|
|
|
|
- Operation ID: `upsert_api_token`
|
|
- Route: `PUT /api/v1/api-tokens/{apiTokenId}`
|
|
- Mode: WRITE
|
|
- Summary: Upsert an API token network condition
|
|
- Parameters:
|
|
- `apiTokenId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### revoke_api_token
|
|
|
|
- Operation ID: `revoke_api_token`
|
|
- Route: `DELETE /api/v1/api-tokens/{apiTokenId}`
|
|
- Mode: WRITE
|
|
- Summary: Revoke an API token
|
|
- Parameters:
|
|
- `apiTokenId` in `path` required
|