Skip to main content
POST
/
v1
/
apps
Create Application
curl --request POST \
  --url https://api.vertracloud.app/v1/apps \
  --header 'Content-Type: application/json' \
  --data '
{
  "memory": "<string>",
  "autorestart": "<string>",
  "start": "<string>",
  "main": "<string>",
  "version": "<string>",
  "name": "<string>",
  "description": "<string>",
  "workspace_id": "<string>",
  "subdomain": "<string>",
  "envs": "<string>"
}
'
{
  "response": {
    "id": "app-abc123def456",
    "owner_id": "user-993591427428790342",
    "owner_plan_id": 1,
    "name": "API Simples",
    "description": "I have a description :)",
    "cluster": 1,
    "status": "up",
    "ram": 128,
    "type": 2,
    "language": "javascript",
    "subdomain": "myapp.vertraweb.app",
    "custom_domain": null,
    "last_snapshot": "2026-03-20T19:58:00Z",
    "main_file": "index.js",
    "version": "recommended",
    "auto_restart": false,
    "start_command": null,
    "use_credits": false,
    "credits_used": 0,
    "offline_since": null,
    "created_at": "2026-03-20T19:58:00Z",
    "updated_at": "2026-03-20T19:58:00Z"
  }
}
file
file
required
The ZIP file containing the application code (maximum size: 100 MB).
memory
string
required
The amount of RAM to allocate for the application in MB.
autorestart
string
Whether the application should restart automatically (true or false). Requires plan support for auto-restart.
start
string
The application startup command.
main
string
required
The main file of the application.
version
string
required
The application runtime version (recommended or latest).
name
string
required
The application name.
description
string
An application description.
workspace_id
string
The workspace ID to associate with the application, if applicable.
subdomain
string
The subdomain for the application (e.g., myapp). Requires plan support for web publishing.
envs
string
A JSON string containing an array of environment variables, each with key and value properties (maximum 25 variables, maximum key length 100, maximum value 1000).

Response

response
object
The details of the created application.
{
  "response": {
    "id": "app-abc123def456",
    "owner_id": "user-993591427428790342",
    "owner_plan_id": 1,
    "name": "API Simples",
    "description": "I have a description :)",
    "cluster": 1,
    "status": "up",
    "ram": 128,
    "type": 2,
    "language": "javascript",
    "subdomain": "myapp.vertraweb.app",
    "custom_domain": null,
    "last_snapshot": "2026-03-20T19:58:00Z",
    "main_file": "index.js",
    "version": "recommended",
    "auto_restart": false,
    "start_command": null,
    "use_credits": false,
    "credits_used": 0,
    "offline_since": null,
    "created_at": "2026-03-20T19:58:00Z",
    "updated_at": "2026-03-20T19:58:00Z"
  }
}

Error Responses

code
string
The error code indicating the reason for the failure. Possible values:
  • UNAUTHORIZED: The user is not authenticated or does not have sufficient permissions.
  • USER_NOT_FOUND: The user’s plan was not found.
  • NO_FILE_UPLOADED: No file was uploaded.
  • FILE_TOO_LARGE: The uploaded file exceeds the 100 MB limit.
  • INVALID_VERSION: The specified version is not recommended or latest.
  • TOO_MANY_ENV_VARIABLES: More than 25 environment variables were provided.
  • ENV_VARIABLE_TOO_LONG: An environment variable key or value exceeds length limits.
  • INVALID_MEMORY: The requested memory is invalid or exceeds plan limits.
  • SUBDOMAIN_ALREADY_IN_USE: The specified subdomain is already in use.
  • INVALID_SUBDOMAIN_LENGTH: The subdomain length is invalid (must be 5-63 characters).
  • FORBIDDEN_SUBDOMAIN: The specified subdomain is restricted.
message
string
A descriptive message providing additional details about the error.
{
  "code": "UNAUTHORIZED"
}