Create Source Deployment
nexusai_deploy_sourceDestructive
Deploy from a Git repository, optionally a sub-folder (rootDir), to NEXUS AI managed infrastructure or a connected AWS, Google Cloud or Azure account. Can add or attach a database and sidecar services. Returns the deployment ID and status.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| region | No | ||
| envVars | No | Non-secret configuration only. Configure passwords, API keys, tokens, and credential-bearing URLs in the authenticated NEXUS AI dashboard, never in chat. | |
| repoUrl | Yes | Git repository URL without embedded credentials. For private repositories, configure access in NEXUS AI and pass repoSecretName. | |
| rootDir | No | Folder inside the repo to deploy, e.g. "backend" or "apps/api". Use it for repos with separate frontend and backend apps; deploy each folder as its own deployment. Defaults to automatic detection from the repo root. | |
| createDb | No | Provision a managed cloud database paired with the deploy provider (Cloud Run→Cloud SQL, App Runner→RDS, Container Apps→Azure Database) and inject its connection env. Requires a cloud provider. | |
| dbRegion | No | Cloud region for createDb (defaults to the deploy region). | |
| memoryMb | No | Container RAM in MB for the NEXUS AI Docker provider. Defaults to 512. Values above 512 require the Pro plan or higher (up to 4096). Use it for apps that build or run in a memory-heavy way. | |
| provider | No | docker|gcp_cloud_run|aws_app_runner|azure_container_apps | |
| services | No | Services to attach at deploy time, matching the CLI's --services flag (e.g. ["postgresql","redis"]). On the docker provider these run as Docker sidecar containers with connection env (DATABASE_URL, REDIS_URL, etc.) auto-injected. On a cloud provider, a postgres/mysql entry is provisioned as a managed database instead (same as createDb); redis/mongodb are not supported on cloud providers. | |
| framework | No | ||
| outputDir | No | ||
| requestId | No | ||
| dockerfile | No | Dockerfile to use: raw contents, a repo-relative path (read after clone), or a GitHub file URL | |
| repoBranch | No | ||
| environment | No | Deployment environment. Defaults to DEVELOPMENT. | |
| managedDbId | No | Attach an existing managed database by ID instead of creating one. Its connection env (DATABASE_URL, etc.) is injected into the first deploy. | |
| buildCommand | No | ||
| startCommand | No | ||
| installCommand | No | ||
| repoSecretName | No | Optional secret name containing private repo token. | |
| dbEngineVersion | No | Engine version for createDb (default: postgres 17 / mysql 8.0). | |
| autoDestroyHours | No | ||
| healthCheckEnabled | No | Set to false to disable health checks. Defaults to true. |