Plan a deployment

Resolves immutable inputs and estimates effects without provider mutation or billable work. The plan targets Dev unless environment is prod; a Prod plan builds straight into Prod, except that a project with shared data and a database only reaches Prod through promotion. Managed mail requires a confirmed Paid service period; it is checked again before build reservation. Selecting the managed Better Auth bridge does not require managed mail or Paid access. An old sender configuration is not Paid authority. A commit the platform does not admit answers 409 with a nonretryable problem code; for framework_conversion_required, detail is a fixed catalog sentence that names the file, the rule and the required change whenever the refusal is typed.

post/v1/projects/{project_id}/deployments:plan

Request

  • Base URL: https://app.ohmyho.st
  • URL: https://app.ohmyho.st/v1/projects/{project_id}/deployments:plan
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project identifier.

Headers

X-Request-Idstring

Optional caller-provided correlation identifier.

Request body

commit_shastring required

Exact full Git commit object identifier; abbreviated or branch references are forbidden.

environment'dev' | 'prod'

The environment the deployment builds into. Prod skips Dev and switches Prod traffic once activated.

Response

A deployment plan valid for 24 hours.

idstring required
project_idstring required
environment'dev' | 'prod' required

The environment this plan builds into.

commit_shastring required

Exact full Git commit object identifier; abbreviated or branch references are forbidden.

source_digeststring required
build_plan_digeststring required
application_rootstring required

Canonical repository-relative application root selected from immutable source evidence.

artifact_digeststring
runtime'cloudflare_workers_static_assets' | 'cloudflare_workers_edge_ssr' required
routestring uri required

Server-derived project-isolated public deployment URL; clients cannot select its gateway host or target Worker.

resource_effectsstring[] required
limitsstring[] required
risksstring[] required
destructive_effectsstring[] required
required_confirmationsstring[] required
created_atstring date-time required
expires_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.