Gateway route management
This guide outlines route management operations for published API Gateway endpoints.
Route management lifecycle
- Deploy Route: Create and publish an endpoint pointing to a workload target.
- Apply Security Policies: Configure open, JWT, or API key authentication modes.
- Configure Edge Restrictions: Attach IP allowlists and rate limit rules.
- Attach Custom Domains: Map custom hostnames with automated TLS management.
- Monitor & Maintain: Rotate API keys, unpublish/republish endpoints, or update policies.
Command reference
| Operation | CLI Command | API Endpoint |
|---|---|---|
| List Endpoints | platformctl gateway endpoint list | GET /v1/projects/{project}/gateway/endpoints |
| Get Endpoint Details | platformctl gateway endpoint get <name> | GET /v1/projects/{project}/gateway/endpoints/{name} |
| Update Authentication | platformctl gateway endpoint update <name> --auth <mode> | PATCH /v1/projects/{project}/gateway/endpoints/{name} |
| Update IP Allowlist | platformctl gateway endpoint update <name> --allow-cidr <cidr> | PATCH /v1/projects/{project}/gateway/endpoints/{name} |
| Update Rate Limit | platformctl gateway endpoint update <name> --rate-limit <limit> | PATCH /v1/projects/{project}/gateway/endpoints/{name} |
| Publish Endpoint | platformctl gateway endpoint publish <name> | POST /v1/projects/{project}/gateway/endpoints/{name}/publish |
| Unpublish Endpoint | platformctl gateway endpoint unpublish <name> | POST /v1/projects/{project}/gateway/endpoints/{name}/unpublish |
| Delete Endpoint | platformctl gateway endpoint delete <name> | DELETE /v1/projects/{project}/gateway/endpoints/{name} |
Route lifecycle states
unpublished: Endpoint created; public URL offline; target workload unaffected.programming: Edge router applying configuration and provisioning certificates (~seconds).ready: Endpoint active and serving live HTTPS traffic.pending_verification: Custom domain CNAME verification in progress.failed: Configuration error; check technical details in Console or API.
Best practices
- Decouple Policy from Code: Apply edge security, IP restrictions, and rate limits at the Gateway level.
- Rotate API Keys: Periodically rotate
apikeycredentials using overlapping validity windows to avoid client downtime. - Use Custom Domains: Assign dedicated subdomains to production endpoints for branded API URLs.