Apps API Reference

Every operation of the Apps API, under /deploy/api. Sign requests with an access key (Authorization: EWS-ACCESS-KEY <id>:<secret>). A successful JSON response is { "success": true, "data": … }.

apps

Deployable applications: what runs, how it is checked, where it is served

hosting

Pooled hosting of a Next.js app: hand over a build, see where and how the app runs (scales to zero)

host-database

A pooled app's Postgres on its pool host: single node, no failover, backed up daily and before a delete

deployments

Rollouts of an app: trigger, read, wait for, cancel

env

Environment of an app: plain values, secrets, synced 1Password references

connections

How each database and cache binding connects — everything but the password

redeploy

Roll the saved configuration out

database

Managed Postgres binding — DATABASE_URL and PG* generated from it

cache

Managed Valkey binding — REDIS_URL and VALKEY_URL generated from it

kafka

Managed Kafka binding — KAFKA_BOOTSTRAP_SERVERS and the SASL settings, as a named user

rabbitmq

Managed RabbitMQ binding — AMQP_URL and AMQP_HOSTS, as a named user

docdb

Document Database binding — MONGODB_URL, as the master user or one of its users

errors

Error Tracking binding — SENTRY_DSN, NEXT_PUBLIC_SENTRY_DSN, SENTRY_ENVIRONMENT, SENTRY_RELEASE and a per-build upload token

jobs

Scheduled jobs (cron) of an app: a command run on a schedule in the app’s image

registry-credentials

Pull credentials for external registries (ghcr.io, Docker Hub, any v2 registry)

domains

Custom domains of an app

Generated from the API description, the same one the API checks requests against and the CLI is built from.