Skip to content
Apiway Docs

Quick Deploy

Quick Deploy is the fastest path from an OpenAPI spec to a live API. It runs an automated 8-step pipeline server-side — you upload the spec and track progress.

How It Works

Section titled “How It Works”

Quick Deploy is available as a command centre action in the management UI, or as a POST /v1/programmes call via the platform API.

  1. Validate Specification — The OAS file is parsed and validated against the OpenAPI 3.x standard. If invalid, the pipeline stops with specific errors.

  2. Compliance Check — Your spec is scored against your organisation’s compliance rules. The score is recorded for governance reviewers.

  3. Generate Recommendations — The recommendations service analyses your API design and generates improvement suggestions.

  4. Submit to Governance — The API enters your governance workflow. The appropriate template is selected based on exposure level and business function.

  5. Await Approval — If manual approval is required, the pipeline pauses. If auto-approval is configured (e.g., internal APIs in dev), this completes immediately.

  6. Deploy to Gateway — The worker generates proxy and policy documents and pushes them as a staging revision.

  7. Create Subscription — A default subscription is created with credentials (OAuth client or API key) for immediate access.

  8. Activate Revision — The staging revision is atomically promoted to active. Your API is live with zero downtime.

Tracking Progress

Section titled “Tracking Progress”
Terminal window
curl https://core.api.apiway.net/v1/programmes/{id}/progress \
  -H "Authorization: Bearer $TOKEN"

Returns the current step, status of each completed step, and any errors.

When Steps Fail

Section titled “When Steps Fail”

If any step fails, the pipeline stops and reports the error. You can:

  • Fix and retry — Correct the issue (e.g., fix an OAS validation error) and re-upload
  • Resume — Some steps can be retried individually without restarting the full pipeline
  • Governance rejection — If reviewers reject the API, you’ll receive feedback explaining why. Address the concerns and resubmit.

Quick Deploy vs Manual Flow

Section titled “Quick Deploy vs Manual Flow”

Quick Deploy automates the same steps you’d take manually through the UI or API. For more control — such as deploying to a specific environment, customising subscription parameters, or choosing a governance template — use the individual API endpoints for each step.