# ohmyho.st

> ## Agent Instructions
> For account actions, read https://ohmyho.st/skills/ohmyhost-get-started/SKILL.md and use the authenticated ohmyho.st CLI or local product MCP. Mintlify search only reads documentation. Preserve the customer’s selected project, environment and authentication provider.

- [Deploy with ohmyho.st](https://docs.ohmyho.st/index.md): Host your GitHub app and manage it through your agent.
- [Your first deployment](https://docs.ohmyho.st/quickstart.md): Connect GitHub, deploy one app and verify its Dev URL.
- [CLI](https://docs.ohmyho.st/cli.md): Install the public clients and deploy a GitHub commit with real commands.
- [Connect your agent](https://docs.ohmyho.st/agents/mcp.md): Use the local ohmyho.st MCP server in Codex, Claude Code, Cursor, Hermes or OpenClaw.
- [MCP tool reference](https://docs.ohmyho.st/mcp-tools.md): Discover the shipped tool names, required arguments and current schemas.
- [Agent Skills](https://docs.ohmyho.st/skills.md): Install focused workflows for deployment and ongoing project work.
- [Login and API tokens](https://docs.ohmyho.st/login-tokens.md): Create a non-expiring automation token, save it once and revoke it when finished.
- [TypeScript SDK](https://docs.ohmyho.st/sdk.md): Call the generated REST client from a trusted server or automation process.
- [Connect GitHub](https://docs.ohmyho.st/github.md): Connect a GitHub installation once per workspace, then link its repositories.
- [Host a Next.js app](https://docs.ohmyho.st/frameworks/nextjs.md): Deploy ordinary Next.js routes with the capabilities your app uses.
- [Host a Vite or React app](https://docs.ohmyho.st/frameworks/vite.md): Deploy a public frontend or a Vite app with its supported server companion.
- [Host a TanStack application](https://docs.ohmyho.st/frameworks/tanstack.md): Distinguish TanStack Start from Router and Query in a Vite app.
- [Functions and cron](https://docs.ohmyho.st/functions.md): Run a Worker module with HTTP and scheduled handlers on the managed runtime.
- [Bring your application’s auth](https://docs.ohmyho.st/application-auth.md): Keep application users and sessions separate from your hosting account.
- [Browser origins and security](https://docs.ohmyho.st/browser-security.md): Declare the external browser resources, embedding, workers and CORS your web app actually uses.
- [Runtime secrets](https://docs.ohmyho.st/secrets.md): Deliver private application values to the environment that needs them.
- [Dev and Prod](https://docs.ohmyho.st/environments.md): Choose shared or isolated data, change assignments or reset Dev, select US or EU and Dev access, then deploy, promote, roll back or delete.
- [Apply schema changes](https://docs.ohmyho.st/migrations.md): Version SQL migrations and preserve existing production data.
- [Postgres queries, writes and compute](https://docs.ohmyho.st/database.md): Call Postgres from your app, query or update Dev/Prod data, open time-bound psql access and inspect compute.
- [Private application files](https://docs.ohmyho.st/files.md): Upload, inspect, read and clean up files through the managed storage client.
- [Connect a domain](https://docs.ohmyho.st/domains.md): Choose a project address, prepare a custom domain before deployment, and connect it through Cloudflare or manual DNS.
- [Transactional email](https://docs.ohmyho.st/email.md): Configure your own sender domain, receive mail through a verified Prod webhook and verify delivery.
- [Read deployment status](https://docs.ohmyho.st/status.md): Follow the accepted operation and inspect the actual application heads.
- [Diagnose a deployment](https://docs.ohmyho.st/troubleshooting.md): Diagnose build, health, runtime, browser, mail and cron failures; resume eligible operations and follow support replies.
- [Support](https://docs.ohmyho.st/support.md): Tell your agent what you need. It reports bugs, issues and feature requests to ohmyho.st and follows up on them.
- [Understand usage](https://docs.ohmyho.st/usage.md): Read measured monthly consumption and the shared organization balance.
- [Credit prices](https://docs.ohmyho.st/pricing.md): Credit prices per measured quantity, plans and top-ups, flag and referral credits, and when usage is charged.
- [Project spending limits](https://docs.ohmyho.st/budgets.md): Set a UTC-month credit limit and choose Continue or Stop.
- [Purchases, invoices and auto-recharge](https://docs.ohmyho.st/billing.md): See the real plan and credit buckets, then manage explicitly authorized payments.
- [Export your database](https://docs.ohmyho.st/backups.md): Request a password-encrypted SQL ZIP and download it when ready.
- [Shared project context](https://docs.ohmyho.st/project-context.md): Let another agent session resume with the current state and project decisions.
- [Report a bug or request a feature](https://docs.ohmyho.st/feedback.md): Give the service a useful redacted report from your customer agent and follow its status.
- [Limits, errors and polling](https://docs.ohmyho.st/limits.md): Understand bounded requests, permissions and long-running operations.
- [Changelog](https://docs.ohmyho.st/changelog.md): Read the current client contract and published service updates.
- [Privacy Notice](https://docs.ohmyho.st/legal/privacy.md): How Amerged B.V. processes account, service and contact data.
- [Cookie Notice](https://docs.ohmyho.st/legal/cookies.md): Technical storage, optional analytics and your cookie choices.
- [Data Processing Agreement](https://docs.ohmyho.st/legal/dpa.md): The agreement for processing customer personal data.
- [Technical and organizational measures](https://docs.ohmyho.st/legal/dpa/toms.md): The measures described for the implemented service.
- [Subprocessors](https://docs.ohmyho.st/legal/dpa/subprocessors.md): The current subprocessors and service roles.
- [International transfers](https://docs.ohmyho.st/legal/dpa/transfers.md): The stated locations and applicable transfer arrangements.
- [API reference](https://docs.ohmyho.st/api.md): Authenticate with your account token and use the same REST contract as CLI and MCP.
- [Read the current interactive user profile and signup attribution](https://docs.ohmyho.st/api-reference/read-the-current-interactive-user-profile-and-signup-attribution.md)
- [Record the authenticated user signup source once](https://docs.ohmyho.st/api-reference/record-the-authenticated-user-signup-source-once.md): Interactive session required; the first accepted source is immutable, repeat requests return it unchanged and no credits or Paid rights are granted by this endpoint.
- [Connect a GitHub installation to the workspace](https://docs.ohmyho.st/api-reference/connect-a-github-installation-to-the-workspace.md): Owner or Admin connects once through one GitHub browser link. The original user session or user API key is bound to the thirty-minute authorization. Repeat the same request and key to observe its result. No provider credential is returned or retained.
- [Read the workspace GitHub connection](https://docs.ohmyho.st/api-reference/read-the-workspace-github-connection.md)
- [Read the workspace's referral link](https://docs.ohmyho.st/api-reference/read-the-workspaces-referral-link.md): Any member may share it. A new user whose first workspace comes from this link starts with 30 days of Paid access and 1,000 credits; that workspace's first payment gives this workspace 1,000 credits and 30 more days of granted Paid access.
- [Read effective plan and monthly versus one-time credit balance](https://docs.ohmyho.st/api-reference/read-effective-plan-and-monthly-versus-one-time-credit-balance.md)
- [Submit a contact or privacy question](https://docs.ohmyho.st/api-reference/submit-a-contact-or-privacy-question.md): Stores a private contact request for twelve months, with idempotent replay and no account creation or marketing enrollment.
- [Read this anonymous browser's current roadmap votes](https://docs.ohmyho.st/api-reference/read-this-anonymous-browsers-current-roadmap-votes.md)
- [Set or remove this anonymous browser's roadmap vote](https://docs.ohmyho.st/api-reference/set-or-remove-this-anonymous-browsers-roadmap-vote.md): Store a desired choice once per request key for twelve months. Replaying an earlier request never overwrites a later choice. A null choice removes the vote; this is not toggle-on-every-request behavior.
- [Read distinct active projects successfully deployed in the past seven days](https://docs.ohmyho.st/api-reference/read-distinct-active-projects-successfully-deployed-in-the-past-seven-days.md)
- [List the current user's tokens in one organization](https://docs.ohmyho.st/api-reference/list-the-current-users-tokens-in-one-organization.md): Requires an interactive session. Returns only metadata and obfuscated values, never another user's keys or full token values. Use the returned cursor for the next page.
- [Create a user-owned API token valid until revoked](https://docs.ohmyho.st/api-reference/create-a-user-owned-api-token-valid-until-revoked.md): Requires a current interactive user session. Organization membership and product permissions are revalidated. Only the first creation returns the full value; exact replay returns metadata and a null value. Save the first response locally without putting it in logs or agent prompts. After uncertainty…
- [Revoke one of the current user's API tokens](https://docs.ohmyho.st/api-reference/revoke-one-of-the-current-users-api-tokens.md): Requires a current interactive session. Verifies user and organization ownership before provider deletion. Replay and an already absent token have the same result. Does not revoke another user's token or the current login session.
- [Store a redacted customer-agent feedback report](https://docs.ohmyho.st/api-reference/store-a-redacted-customer-agent-feedback-report.md): Available to authorized organization members at zero credits. A 201 receipt confirms durable storage, not triage or a promised fix. Reuse the same Idempotency-Key and payload after uncertainty. Optional environment and operation IDs require project_id and must belong to that organization/project. Te…
- [Read the status of one feedback receipt and ohmyho.st's replies](https://docs.ohmyho.st/api-reference/read-the-status-of-one-feedback-receipt-and-ohmyhosts-replies.md): Available at zero credits to callers who may submit feedback in the report's stored organization or project scope. Returns the receipt, the current status and update time of the complete customer-visible history, and one page of at most 25 customer-visible operator updates, oldest first; pass next_c…
- [Complete the bound GitHub browser authorization](https://docs.ohmyho.st/api-reference/complete-the-bound-github-browser-authorization.md): Browser callback only. Revalidates the original user session or user API key, workspace Owner/Admin authority and authorization expiry, then privately verifies the GitHub account and installation. A valid installation callback without an OAuth code continues automatically through OAuth. Completion r…
- [Complete one Cloudflare DNS authorization](https://docs.ohmyho.st/api-reference/complete-one-cloudflare-dns-authorization.md): Successful callbacks require code and state and complete one previously authenticated project authorization. Provider rejection instead supplies error and optional error_description, error_uri and state; it returns a static actionable problem without completing authorization or reflecting provider i…
- [Get the current authenticated identity](https://docs.ohmyho.st/api-reference/get-the-current-authenticated-identity.md): Returns the stable ohmyhost actor and internal organization identifiers derived from the bearer credential.
- [Revoke the current signed-in user session](https://docs.ohmyho.st/api-reference/revoke-the-current-signed-in-user-session.md): Revokes only the session proven by the bearer credential, confirms its absence from active WorkOS sessions and records local terminal denial. No organization is required. The request body and query must be empty; caller-supplied session or user identifiers are not accepted. Repeated private processi…
- [Create an organization for the signed-in user](https://docs.ohmyho.st/api-reference/create-an-organization-for-the-signed-in-user.md): Creates an organization and its creator's Owner membership. Only a verified user session may call this endpoint; no existing organization is required. Repeating the same Idempotency-Key and name observes the same creation, never recreating revoked membership. Creation does not change the caller's to…
- [Create or resume an owner's hosted Stripe Checkout](https://docs.ohmyho.st/api-reference/create-or-resume-an-owners-hosted-stripe-checkout.md): Returns a human payment URL, never charges a saved card. Paid is USD 10/month; each top-up pack is USD 10 before tax; a purchase grants 100 credits per dollar up to USD 100 and 125 credits per dollar for the part above, so 10 packs grant 10000 and 20 packs grant 22500 credits. Top-ups require active…
- [Observe and reconcile an owner's original checkout](https://docs.ohmyho.st/api-reference/observe-and-reconcile-an-owners-original-checkout.md): Reads Stripe and reconciles confirmed credits/refunds idempotently. payment_confirmed describes the original Checkout, not spendable credit or current Paid entitlement. Read organization credits for available funding and the organization account's effective plan for Paid coverage; paid_until is the…
- [Open the owner's Stripe billing portal](https://docs.ohmyho.st/api-reference/open-the-owners-stripe-billing-portal.md): Creates a short-lived human URL for invoices, payment method updates and cancellation at period end. Does not charge or change the subscription itself. Customer and return URL are server-selected. Request a fresh URL if the portal has expired. Works at zero credits.
- [Read auto-recharge and the current payment handoff](https://docs.ohmyho.st/api-reference/read-auto-recharge-and-the-current-payment-handoff.md): Owner-only. Reads saved consent and gross UTC-month spending; a pending Stripe card setup may be resumed. No charge is initiated by reading. Private Stripe URLs must not be logged.
- [Enable or disable explicitly authorized auto-recharge](https://docs.ohmyho.st/api-reference/enable-or-disable-explicitly-authorized-auto-recharge.md): Owner-only. An agent must obtain explicit approval for off-session charges and the gross monthly spending cap before enabling. Each refill costs USD 9 before tax for 1000 top-up credits when available credits fall below 100. Active Paid access is required to enable recharge and initiate a payment; r…
- [Read the owner's shared organization credit pool](https://docs.ohmyho.st/api-reference/read-the-owners-shared-organization-credit-pool.md): Returns posted credits and reservations, in microcredits (one credit is 1000000 microcredits). Monthly entitlement posting is idempotent. Only the organization Owner may read this balance. active_meters names the currently billed sources; unreported usage is not included. platform_overrun_micros is…
- [Read monthly measured usage by project and meter](https://docs.ohmyho.st/api-reference/read-monthly-measured-usage-by-project-and-meter.md): Owner-only event-month ledger totals, including signed corrections posted by as_of. Returns up to 20 projects per page in ID order; use next_cursor with the same month. Current unresolved reservations are separate from measured consumption. Null environment_id means project-shared cost, never guesse…
- [Request an asynchronous password-encrypted SQL ZIP](https://docs.ohmyho.st/api-reference/request-an-asynchronous-password-encrypted-sql-zip.md): Owner-only and available at zero credits. Exports each confirmed physical project database once, including separate Dev/Prod SQL or one shared SQL file. Excludes files, source code and configuration. At most one accepted export per project per rolling 24 hours; failed jobs still count and idempotent…
- [Read export progress and its verified 24-hour download capability](https://docs.ohmyho.st/api-reference/read-export-progress-and-its-verified-24-hour-download-capability.md): Owner-only, including at zero credits. Poll queued/running jobs after next_poll_after_seconds. A verified SQL ZIP is retained seven days. Its signed download URL is valid 24 hours and is issued only with at least 24 hours of retention left; otherwise download fields are null. Treat the URL as a secr…
- [Read a project's optional monthly credit budget](https://docs.ohmyho.st/api-reference/read-a-projects-optional-monthly-credit-budget.md): Owner-only snapshot of UTC-calendar-month measured usage and all open reservations. No budget means shared organization funds; continue mode does not stop at the threshold.
- [Set or clear the owner's project budget](https://docs.ohmyho.st/api-reference/set-or-clear-the-owners-project-budget.md): Changes only the budget policy, never credit grants or usage. amount_micros null clears the budget and requires continue mode. stop rejects new billable work when measured monthly usage plus reservations reaches the limit. This local setting completes atomically with its operation, audit and idempot…
- [List projects visible to the current authenticated identity](https://docs.ohmyho.st/api-reference/list-projects-visible-to-the-current-authenticated-identity.md): Returns a stable ULID-ordered page across only the caller's authorized organizations. A session that selected no workspace can see nothing and returns organization_required (409) instead of an empty page; select a workspace and repeat.
- [Create a project](https://docs.ohmyho.st/api-reference/create-a-project.md): Atomically records the project and a durable operation for asynchronous processing.
- [Get a project](https://docs.ohmyho.st/api-reference/get-a-project.md)
- [Delete a project](https://docs.ohmyho.st/api-reference/delete-a-project.md): Asynchronously reconciles all project-owned resources and is safe to repeat.
- [Read current project context for an agent](https://docs.ohmyho.st/api-reference/read-current-project-context-for-an-agent.md): At most 500 lines / 32768 UTF-8 bytes of Markdown generated from current project, domain and mail state plus shared notes. Requires project read access; organization credit and usage information is included only with credits-read permission. Component observation failures are explicit; no cached suc…
- [Replace bounded shared project notes without losing concurrent edits](https://docs.ohmyho.st/api-reference/replace-bounded-shared-project-notes-without-losing-concurrent-edits.md): Requires project write access. Read context first and pass notes.version as expected_version (zero for a new document). Maximum 250 lines and 16384 UTF-8 bytes; line endings normalize to LF. Empty Markdown clears notes. Never store secrets, logs or signed access URLs. Exact Idempotency-Key replay re…
- [Get the current project deployment status](https://docs.ohmyho.st/api-reference/get-the-current-project-deployment-status.md): Returns the immutable project handle, current source, default environment, head deployment, independently evidenced dev and prod gateway origins, latest operation, and cleanup state without exposing provider credentials.
- [Check whether a project handle is free](https://docs.ohmyho.st/api-reference/check-whether-a-project-handle-is-free.md): Reports whether a handle can be used for a project and why not when it cannot, with free alternatives an agent can offer. A handle is one to five lowercase words of letters and digits separated by single hyphens, three to fifty-nine characters, and never one of the reserved words. Availability is an…
- [Get or create the persistent Dev share link](https://docs.ohmyho.st/api-reference/get-or-create-the-persistent-dev-share-link.md): Owner-only. Repeated calls return the same protected Dev link until it is rotated or revoked. The link is a bearer credential without automatic expiry.
- [Revoke the Dev share link and active sessions](https://docs.ohmyho.st/api-reference/revoke-the-dev-share-link-and-active-sessions.md)
- [Rotate the persistent Dev share link](https://docs.ohmyho.st/api-reference/rotate-the-persistent-dev-share-link.md): Owner-only. Reusing the same idempotency key returns the current rotated link; rotating invalidates previous links and sessions immediately.
- [Select public or protected Dev access](https://docs.ohmyho.st/api-reference/select-public-or-protected-dev-access.md): Owner-only. Public Dev needs no platform access link; switching back to protected creates a fresh link and invalidates earlier sessions.
- [Read the "Powered by ohmyho.st" flag](https://docs.ohmyho.st/api-reference/read-the-"powered-by-ohmyhost"-flag.md): Whether the production site shows the opt-in flag for the current owner organization.
- [Show or hide the "Powered by ohmyho.st" flag](https://docs.ohmyho.st/api-reference/show-or-hide-the-"powered-by-ohmyhost"-flag.md): Owner-only. The production site shows a small flag on its right edge that links to ohmyho.st. While it is on, a Free workspace may connect its own domain to this project and the custom-hostname fee is waived; each Paid period bought through Stripe adds 250 credits to the organization, however many o…
- [Create a single-use dev access ticket](https://docs.ohmyho.st/api-reference/create-a-single-use-dev-access-ticket.md): Owner-only issuance of a one-hour single-use ticket for the immutable dev project origin. A new ticket revokes unused tickets previously issued to the same principal.
- [Plan project deletion](https://docs.ohmyho.st/api-reference/plan-project-deletion.md): Produces a non-mutating project deletion plan and a ten-minute action-bound confirmation token.
- [Link a GitHub source repository](https://docs.ohmyho.st/api-reference/link-a-github-source-repository.md): Uses the workspace GitHub connection to admit a source-link operation without another browser authorization or a build. The caller must have current sources:link permission and the connected installation must cover the repository. If the workspace is not connected, run github connect first; if repos…
- [Get the linked source status](https://docs.ohmyho.st/api-reference/get-the-linked-source-status.md)
- [Get automatic GitHub push deployment status](https://docs.ohmyho.st/api-reference/get-automatic-github-push-deployment-status.md)
- [Configure automatic GitHub push deployment](https://docs.ohmyho.st/api-reference/configure-automatic-github-push-deployment.md): Configures exactly one Git branch whose signed pushes deploy immutable commits to dev. Production remains an explicit promotion.
- [Start project-scoped Cloudflare DNS authorization](https://docs.ohmyho.st/api-reference/start-project-scoped-cloudflare-dns-authorization.md): Creates or replays one short-lived authorization URL for the customer Cloudflare zone bound to the project's Paid domain. Pending requests replay the original handoff. Expired or consumed requests return cloudflare_authorization_closed (409); read current DNS authorization status and reuse a valid m…
- [Get project-scoped Cloudflare DNS authorization status](https://docs.ohmyho.st/api-reference/get-project-scoped-cloudflare-dns-authorization-status.md): Returns only the fixed zone, closed scope set, expiry, and authorization state; provider credentials are never exposed.
- [Move a project to a chosen address](https://docs.ohmyho.st/api-reference/move-a-project-to-a-chosen-address.md): Starts a durable operation that re-publishes the project's Dev and Prod gateways at the chosen address and stores it only once both serve it. The previous address stops answering and returns to the pool for any project to claim. Ask GET /v1/project-handles/{handle} first; a taken, unusable or unchan…
- [Apply the server-derived project domains](https://docs.ohmyho.st/api-reference/apply-the-server-derived-project-domains.md): Starts an idempotent durable operation for the exact project-derived development, production, and mail hostnames. The request has no body.
- [Plan one Paid customer-owned hostname](https://docs.ohmyho.st/api-reference/plan-one-paid-customer-owned-hostname.md): Plan the customer's requested hostname before or after the first Prod deployment. This read-only plan explains declaration, Cloudflare consent and activation; it does not claim the hostname, create provider resources or change DNS.
- [Read the Paid customer-owned hostname](https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname.md)
- [Apply one Paid customer-owned hostname](https://docs.ohmyho.st/api-reference/apply-one-paid-customer-owned-hostname.md): Requires Paid access (a Stripe period or a grant) or, for a Free workspace, a project that currently shows the powered-by flag, and no expired credit-exhaustion grace. Returns paid_plan_required otherwise, or insufficient_organization_credits after seven days with no available credits, without provi…
- [Delete one exact Paid customer-owned hostname](https://docs.ohmyho.st/api-reference/delete-one-exact-paid-customer-owned-hostname.md)
- [Plan a deployment](https://docs.ohmyho.st/api-reference/plan-a-deployment.md): 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 c…
- [List deployments](https://docs.ohmyho.st/api-reference/list-deployments.md)
- [Create a deployment](https://docs.ohmyho.st/api-reference/create-a-deployment.md): Reserves the quoted build credits from the shared organization pool and starts the exact reviewed plan as one durable operation. Insufficient available credits or an explicit project stop budget rejects before operation creation or provider work. Repeating the accepted request never reserves twice.
- [Get deployment status](https://docs.ohmyho.st/api-reference/get-deployment-status.md)
- [List normalized deployment diagnostics](https://docs.ohmyho.st/api-reference/list-normalized-deployment-diagnostics.md)
- [Stream normalized deployment diagnostics](https://docs.ohmyho.st/api-reference/stream-normalized-deployment-diagnostics.md)
- [Read actual managed database compute configuration](https://docs.ohmyho.st/api-reference/read-actual-managed-database-compute-configuration.md): Project readers can observe current Dev or Prod compute without receiving provider IDs or credentials and without executing SQL or waking the database. Explicitly shared data resolves to the same physical database for both environments. A null database means the owned environment has no confirmed ma…
- [Select standard or Paid performance database compute](https://docs.ohmyho.st/api-reference/select-standard-or-paid-performance-database-compute.md): Requires project-write access and explicit confirmation. Reads the organization plan at acceptance (Free 0.25 CU/1 GB/60 idle seconds or Paid 0.5 CU/2 GB/60 idle seconds). Changes the existing database in place without copying or resetting data. Shared Dev/Prod data changes both environments. A brie…
- [Execute one bounded database write in Dev or Prod](https://docs.ohmyho.st/api-reference/execute-one-bounded-database-write-in-dev-or-prod.md): Owner-authorized INSERT, UPDATE or DELETE through the restricted runtime role, including ordinary upsert. Environment is mandatory. One direct statement and transaction, five-second timeout and at most 1000 directly affected rows; customer triggers and cascades may affect more rows. Rows are not ret…
- [Run one bounded read-only Dev or Prod database query](https://docs.ohmyho.st/api-reference/run-one-bounded-read-only-dev-or-prod-database-query.md): Executes one SELECT through the project's least-privilege read-only role. Application row-level security policies apply and may filter rows; a complete SQL archive uses the separate authorized export workflow. Connection credentials are never returned.
- [List the project's issued database credentials](https://docs.ohmyho.st/api-reference/list-the-projects-issued-database-credentials.md): Returns at most the 50 newest credentials with their derived state (active, expired or revoked). Connection URIs and passwords are never returned again; only the credential metadata is readable.
- [Issue one time-bound PostgreSQL credential for Dev or Prod](https://docs.ohmyho.st/api-reference/issue-one-time-bound-postgresql-credential-for-dev-or-prod.md): Owner-authorized direct PostgreSQL login for the project's own database, returned exactly once and never retrievable again. Mode read joins the read-only role, mode write joins the same restricted runtime role the application uses; neither can change schema, and application row-level security polici…
- [Revoke one issued database credential](https://docs.ohmyho.st/api-reference/revoke-one-issued-database-credential.md): Ends the credential's open sessions and removes its PostgreSQL role. Revocation is idempotent for an already revoked credential and never affects the application's own roles or any data.
- [Plan a deployment rollback](https://docs.ohmyho.st/api-reference/plan-a-deployment-rollback.md): Produces a non-mutating rollback plan for an immutable deployment artifact.
- [Roll back to an immutable deployment](https://docs.ohmyho.st/api-reference/roll-back-to-an-immutable-deployment.md): Republishes the target deployment artifact without starting a new build.
- [Plan promotion of the current dev deployment](https://docs.ohmyho.st/api-reference/plan-promotion-of-the-current-dev-deployment.md): Produces a non-mutating, ten-minute plan that binds the current succeeded dev deployment and current prod head without rebuilding the artifact.
- [Promote a verified dev artifact to prod](https://docs.ohmyho.st/api-reference/promote-a-verified-dev-artifact-to-prod.md): Activates the immutable artifact from the current succeeded dev deployment in prod without rebuilding it.
- [List environment secret metadata](https://docs.ohmyho.st/api-reference/list-environment-secret-metadata.md): Returns names and revisions only. Secret values are never readable through the public API.
- [List the newest scheduled function runs of an environment](https://docs.ohmyho.st/api-reference/list-the-newest-scheduled-function-runs-of-an-environment.md): Every declared cron produces one run per due UTC minute; the newest runs come first. A run reports its state, attempt, the status the scheduled handler returned and its timing. Values never include request or response bodies.
- [Create or rotate an environment secret](https://docs.ohmyho.st/api-reference/create-or-rotate-an-environment-secret.md): Accepts a write-only value and returns metadata only. Replays require the same canonical value digest.
- [Delete an environment secret](https://docs.ohmyho.st/api-reference/delete-an-environment-secret.md)
- [Get an operation](https://docs.ohmyho.st/api-reference/get-an-operation.md)
- [Reconcile an uncertain platform delivery or provider mutation](https://docs.ohmyho.st/api-reference/reconcile-an-uncertain-platform-delivery-or-provider-mutation.md): Owner-only, idempotent recovery for an operation retained after an uncertain platform delivery or provider mutation. The control plane derives the exact recovery decision, including any deterministic internal Workflow handoff; the request has no body. Exhausted lifecycle recovery returns reconciliat…
- [Stream operation events](https://docs.ohmyho.st/api-reference/stream-operation-events.md)
- [List audit events](https://docs.ohmyho.st/api-reference/list-audit-events.md): Returns events visible to the authenticated organization in stable descending order.
- [Read independent sending and receiving readiness](https://docs.ohmyho.st/api-reference/read-independent-sending-and-receiving-readiness.md): One production mail domain per project; environment_id is the project Prod environment ID. Dev and Prod application URLs do not create separate mail domains. Provider credentials never leave ohmyho.st. Content expires 72 hours after original receipt.
- [Configure sending and receiving on a selected mail domain](https://docs.ohmyho.st/api-reference/configure-sending-and-receiving-on-a-selected-mail-domain.md): One production mail domain per project; environment_id is the project Prod environment ID. Dev and Prod application URLs do not create separate mail domains. Provider credentials never leave ohmyho.st. Content expires 72 hours after original receipt.
- [Retire the project's mail domain while the project stays active](https://docs.ohmyho.st/api-reference/retire-the-projects-mail-domain-while-the-project-stays-active.md): Ends sending and receiving at once, removes the webhook, then removes the domain and its sending key from the mail provider and confirms their absence. DNS is not changed; dns_records lists the records to remove from the domain's DNS, including any that Cloudflare authorization added. Repeat the sam…
- [Prepare a required customer webhook and return its signing secret](https://docs.ohmyho.st/api-reference/prepare-a-required-customer-webhook-and-return-its-signing-secret.md): One production mail domain per project; environment_id is the project Prod environment ID. Dev and Prod application URLs do not create separate mail domains. Provider credentials never leave ohmyho.st. Content expires 72 hours after original receipt.
- [Disable receiving and remove the customer webhook](https://docs.ohmyho.st/api-reference/disable-receiving-and-remove-the-customer-webhook.md): One production mail domain per project; environment_id is the project Prod environment ID. Dev and Prod application URLs do not create separate mail domains. Provider credentials never leave ohmyho.st. Content expires 72 hours after original receipt.
- [Verify the customer endpoint and enable receiving](https://docs.ohmyho.st/api-reference/verify-the-customer-endpoint-and-enable-receiving.md): One production mail domain per project; environment_id is the project Prod environment ID. Dev and Prod application URLs do not create separate mail domains. Provider credentials never leave ohmyho.st. Content expires 72 hours after original receipt.
- [List mail handoff metadata within the 72 hour window](https://docs.ohmyho.st/api-reference/list-mail-handoff-metadata-within-the-72-hour-window.md): One production mail domain per project; environment_id is the project Prod environment ID. Dev and Prod application URLs do not create separate mail domains. Provider credentials never leave ohmyho.st. Content expires 72 hours after original receipt.
- [Retrieve owned mail content before expiry](https://docs.ohmyho.st/api-reference/retrieve-owned-mail-content-before-expiry.md): One production mail domain per project; environment_id is the project Prod environment ID. Dev and Prod application URLs do not create separate mail domains. Provider credentials never leave ohmyho.st. Content expires 72 hours after original receipt.
- [Retry within the shared maximum of three retries](https://docs.ohmyho.st/api-reference/retry-within-the-shared-maximum-of-three-retries.md): One production mail domain per project; environment_id is the project Prod environment ID. Dev and Prod application URLs do not create separate mail domains. Provider credentials never leave ohmyho.st. Content expires 72 hours after original receipt.
- [Download an owned attachment before expiry](https://docs.ohmyho.st/api-reference/download-an-owned-attachment-before-expiry.md): One production mail domain per project; environment_id is the project Prod environment ID. Dev and Prod application URLs do not create separate mail domains. Provider credentials never leave ohmyho.st. Content expires 72 hours after original receipt. Downloads over 50 MiB return 413.
- [Plan a Dev and Prod data assignment change](https://docs.ohmyho.st/api-reference/plan-a-dev-and-prod-data-assignment-change.md): Plans one of four Owner-only changes without copying data and issues a ten-minute action-bound confirmation token. shared remains the default at project creation. A Dev reset preserves secrets and access mode and renews a protected share link.
- [Execute a confirmed Dev and Prod data assignment change](https://docs.ohmyho.st/api-reference/execute-a-confirmed-dev-and-prod-data-assignment-change.md): Accepts an asynchronous Owner-only data change with the plan ETag, X-Confirmation-Token and Idempotency-Key. It never deletes the data area Prod keeps. Retired Dev resources are removed after access and outstanding upload capabilities are fenced; uncertain effects remain reconcilable.

## OpenAPI Specs

- [openapi](/openapi.json)
- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.