register_deployment
Register a self-hosted Gateway deployment to onboard a new control-plane target. Store returned credentials securely and immediately, as they are exposed only once.
Instructions
Enterprise-gated. Register a self-hosted Gateway deployment when onboarding a new control-plane target; use list_deployments for existing registrations. The response can contain authentication and registry credentials exactly once, exposed to this MCP transcript, so store them securely immediately and never log them. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Deployment display name | |
| slug | No | Optional deployment slug | |
| type | No | Production or non-production deployment type | |
| is_default | No | Make this the default deployment | |
| organisation_id | No | Owning organisation UUID | |
| gateway_base_url | No | Self-hosted Gateway base URL | |
| jwt_subs_allowed | No | JWT subject values allowed to use the deployment | |
| deployment_config | No | Gateway deployment configuration | |
| workspaces_allowed | No | Workspace slugs this deployment may serve; empty allows all | |
| mcp_gateway_base_url | No | MCP Gateway base URL | |
| is_dataservice_hosted | No | Whether the deployment hosts its own data service | |
| jwt_sub_workspace_mapping | No | JWT subject to workspace-slug mapping | |
| is_playground_proxy_allowed | No | Whether Playground proxy traffic is allowed |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | Whether the tool call succeeded and returned structured data | |
| data | No | Structured success payload when ok is true | |
| error | No | Structured error payload when ok is false |