Skip to content
Internal Engineering Docs

Deploy Gateway

Prerequisites

  • Admin credentials for the Control Plane
  • VITE_CONTROL_PLANE_URL set in your local env

Steps

  1. Open the Control Plane admin UI at $APP_PUBLIC_ADMIN_URL.
  2. Navigate to Tenants → [Tenant name].
  3. Click Compile & Deploy Gateway.
  4. Monitor the status indicator — it transitions pending → compiling → active.

CLI alternative

Terminal window
curl -X POST $CONTROL_PLANE_URL/v1/gateway/compile \
  -H "Authorization: Bearer $ADMIN_KEY" \
  -d '{"tenantId": "<tenant-id>"}'

Verification

After deploy, check the Gateway page for the new version number. Run a smoke test:

Terminal window
curl -H "Authorization: Bearer $TEST_API_KEY" \
     $GATEWAY_URL/v1/ping

Rollback

If the new version causes errors, click Rollback next to the previous version in the Gateway table.