bridgectl_api_register
bridgectl api registerโ
Register a new ERP API endpoint
Synopsisโ
Register an ERP API endpoint in the local registry. This step is usually the first part of the workflow, defining how the middleware connects to the ERP. Once registered, you can generate an MCP tool schema from this API definition.
bridgectl api register [flags]
Examplesโ
bridgectl api register \
--name get-invoices \
--url "http://erp.local/api/v1/invoices" \
--method GET \
--module finance \
--description "Fetch all invoices" \
--auth-type api-key \
--credential-ref ERP_API_KEY
Optionsโ
--auth-header string Auth header (default "X-API-Key")
--auth-type string Auth type (default "api-key")
--credential-ref string Logical credential reference
--credential-source string Credential source: env or file (default "env")
--description string Human-readable description
--force Replace an existing API with the same name
-h, --help help for register
--method string HTTP method (default "GET")
--module string ERP module
--name string Unique name for this API
--url string Full URL of the ERP endpoint
Options inherited from parent commandsโ
-c, --context string Override active context
-o, --output string Output format: table, json, yaml (default "table")
--token string API token for the ERPBridge server
-v, --verbose Show full HTTP request/response detail
SEE ALSOโ
- bridgectl api - Manage ERP API endpoints