67 lines
2.4 KiB
Markdown
67 lines
2.4 KiB
Markdown
---
|
|
name: internal-routes
|
|
description: Handle 5 OpenAPI operation(s) under /api/v1/internal for the internal route group.
|
|
---
|
|
|
|
# internal API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /api/v1/internal for the internal 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
|
|
|
|
### api_list_all_verified_domains_api_v1_internal_domains_verified_get
|
|
|
|
- Operation ID: `api_list_all_verified_domains_api_v1_internal_domains_verified_get`
|
|
- Route: `GET /api/v1/internal/domains/verified`
|
|
- Mode: READ
|
|
- Summary: List all verified custom domains
|
|
- Parameters:
|
|
- `x-internal-key` in `header` required
|
|
|
|
### api_activate_pack_api_v1_internal_packs_org_id_activate_post
|
|
|
|
- Operation ID: `api_activate_pack_api_v1_internal_packs_org_id_activate_post`
|
|
- Route: `POST /api/v1/internal/packs/{org_id}/activate`
|
|
- Mode: WRITE
|
|
- Summary: Activate a pack for an organization
|
|
- Parameters:
|
|
- `org_id` in `path` required
|
|
- `x-platform-key` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_mark_pack_canceling_api_v1_internal_packs_org_id_mark_canceling_patch
|
|
|
|
- Operation ID: `api_mark_pack_canceling_api_v1_internal_packs_org_id_mark_canceling_patch`
|
|
- Route: `PATCH /api/v1/internal/packs/{org_id}/mark-canceling`
|
|
- Mode: WRITE
|
|
- Summary: Mark a pack as canceling
|
|
- Parameters:
|
|
- `org_id` in `path` required
|
|
- `x-platform-key` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_deactivate_pack_api_v1_internal_packs_org_id_deactivate_delete
|
|
|
|
- Operation ID: `api_deactivate_pack_api_v1_internal_packs_org_id_deactivate_delete`
|
|
- Route: `DELETE /api/v1/internal/packs/{org_id}/deactivate`
|
|
- Mode: WRITE
|
|
- Summary: Deactivate a pack
|
|
- Parameters:
|
|
- `org_id` in `path` required
|
|
- `x-platform-key` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_deactivate_all_packs_api_v1_internal_packs_org_id_deactivate_all_delete
|
|
|
|
- Operation ID: `api_deactivate_all_packs_api_v1_internal_packs_org_id_deactivate_all_delete`
|
|
- Route: `DELETE /api/v1/internal/packs/{org_id}/deactivate-all`
|
|
- Mode: WRITE
|
|
- Summary: Deactivate all packs for an organization
|
|
- Parameters:
|
|
- `org_id` in `path` required
|
|
- `x-platform-key` in `header` required
|