route_update
Modify an existing Edge Routine route configuration to update settings like enable status, rules, routines, and bypass options for site security management.
Instructions
Modify the configuration of an existing Edge Routine route.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | Yes | The ID of the site | |
| configId | Yes | The ID of the config | |
| routeName | Yes | The name of the route, use to identify the route. | |
| routeEnable | Yes | The enable of the route | |
| rule | Yes | The rule of the route | |
| routineName | Yes | The name of the routine | |
| bypass | Yes | The bypass of the route | |
| sequence | No | The sequence of the route, if not passed, default is the current number of routes |
Implementation Reference
- src/tools/er/route.ts:266-286 (handler)The primary handler function for the 'route_update' tool. It processes the request arguments, handles 'simple' and 'custom' modes by calling api.updateRoutineRoute, and returns the result as JSON.export const route_update = async (request: CallToolRequest) => { const { mode, route } = request.params.arguments as CreateRoutineRouteRequest; if (mode === 'simple') { const res = await api.updateRoutineRoute({ ...request.params.arguments, rule: transferRouteToRuleString(route), } as unknown as UpdateRoutineRouteRequest); return { content: [{ type: 'text', text: JSON.stringify(res) }], success: true, }; } else { const res = await api.updateRoutineRoute( request.params.arguments as UpdateRoutineRouteRequest, ); return { content: [{ type: 'text', text: JSON.stringify(res) }], success: true, }; } };
- src/tools/er/route.ts:75-127 (schema)The Tool object defining the 'route_update' tool, including its name, description, and detailed inputSchema with properties and required fields.export const ROUTE_UPDATE_TOOL: Tool = { name: 'route_update', description: 'Modify the configuration of an existing Edge Routine route.', inputSchema: { type: 'object', properties: { siteId: { type: 'number', description: 'The ID of the site', }, configId: { type: 'number', description: 'The ID of the config', }, routeName: { type: 'string', description: 'The name of the route, use to identify the route.', }, routeEnable: { type: 'enum', enum: ['on', 'off'], description: 'The enable of the route', }, rule: { type: 'string', description: 'The rule of the route', }, routineName: { type: 'string', description: 'The name of the routine', }, bypass: { type: 'enum', enum: ['on', 'off'], description: 'The bypass of the route ', }, sequence: { type: 'number', description: 'The sequence of the route, if not passed, default is the current number of routes', }, }, required: [ 'siteId', 'configId', 'routeName', 'routeEnable', 'rule', 'routineName', 'bypass', ], }, };
- src/tools/list-esa-function.ts:103-123 (registration)Registration of ROUTE_UPDATE_TOOL in the ESA_OPENAPI_ER_LIST array, which collects tools for the ESA OpenAPI ER category.export const ESA_OPENAPI_ER_LIST = [ HTML_DEPLOY_TOOL, ROUTINE_CREATE_TOOL, ROUTINE_DELETE_TOOL, ROUTINE_LIST_TOOL, ROUTINE_GET_TOOL, ROUTINE_CODE_COMMIT_TOOL, ROUTINE_CODE_DEPLOY_TOOL, ROUTINE_ROUTE_LIST_TOOL, DEPLOYMENT_DELETE_TOOL, SITE_ACTIVE_LIST_TOOL, SITE_ROUTE_LIST_TOOL, ROUTE_CREATE_TOOL, ROUTE_DELETE_TOOL, ROUTE_UPDATE_TOOL, ROUTE_GET_TOOL, SITE_MATCH_TOOL, ER_RECORD_CREATE_TOOL, ER_RECORD_DELETE_TOOL, ER_RECORD_LIST_TOOL, ];
- src/tools/list-esa-function.ts:164-208 (registration)Registration of the route_update handler function in the esaHandlers object, which maps tool names to their handler functions.export const esaHandlers: ToolHandlers = { site_active_list, site_match, site_route_list, site_record_list, routine_create, routine_code_commit, routine_delete, routine_list, routine_get, routine_code_deploy, routine_route_list, deployment_delete, route_create, route_delete, route_update, route_get, er_record_create, er_record_delete, er_record_list, html_deploy, create_site, update_site_pause, get_site_pause, create_site_mx_record, create_site_ns_record, create_site_txt_record, create_site_cname_record, create_site_a_or_aaaa_record, update_record, list_records, get_record, delete_record, update_ipv6, get_ipv6, update_managed_transform, get_managed_transform, set_certificate, apply_certificate, get_certificate, delete_certificate, list_certificates, get_certificate_quota, list_sites, };
- src/tools/list-esa-function.ts:9-22 (registration)Import statement bringing in the route_update handler and ROUTE_UPDATE_TOOL schema from the route module.import { route_create, ROUTE_CREATE_TOOL, route_delete, ROUTE_DELETE_TOOL, route_get, ROUTE_GET_TOOL, route_update, ROUTE_UPDATE_TOOL, routine_route_list, ROUTINE_ROUTE_LIST_TOOL, site_route_list, SITE_ROUTE_LIST_TOOL, } from './er/route';