Skip to main content

Draft & Publish

Zerq uses a draft/published lifecycle for both Collections and Proxies. This lets you configure and test endpoints without exposing them to clients or the Developer Portal.

Statuses​

StatusGatewayDeveloper PortalAdmin UI
Draft❌ Not accessible❌ Hidden✅ Visible
Published✅ Accessible✅ Visible✅ Visible

Collections​

  • A collection in draft hides all its proxies from clients and the portal
  • Publishing a collection does not automatically publish its proxies — each proxy must be published individually
  • You can toggle a collection's status without affecting its proxies' individual statuses

Proxies​

  • A proxy in draft is not routable, even if its parent collection is published
  • Publish a proxy when it is ready for live traffic
  • Unpublish a proxy to take it offline without deleting it

Typical workflow​

1. Create collection (draft)
2. Add proxies and configure them (draft)
3. Test internally (via admin API or workflow testing)
4. Publish proxies that are ready
5. Publish the collection
6. Assign the collection to clients

Toggling status​

  • Collection: Click the status toggle on the Collections list page, or use the Publish / Unpublish button in the collection detail view
  • Proxy: Click the status badge or toggle in the proxy list

Bulk operations​

When you duplicate a collection, all copied proxies are created in draft status regardless of the original's status. This prevents accidentally publishing a copy before it's been reviewed.

API lifecycle​

For CI/CD pipelines, you can automate publish/unpublish through the Management API:

# Publish a collection
PUT /api/v1/collections/:id/status
{ "status": "published" }

# Unpublish a proxy
PUT /api/v1/proxies/:id
{ "status": "draft" }
  • Collections — configure collection settings and credentials
  • Proxies — manage individual proxy routes and status