Sleep mode & resources

Any existing project has a Machine Power card. On a single app it's under Configuration; on a multi-service (compose) project it's on the Services tab, since that project shape has no single-app Configuration.

The card shows the target machine's detected capacity in its header, and offers:

• Full capacity — the default on connected and managed servers. The container shares the host’s available capacity.
• Micro / Low / Medium / High / Extra large — the same presets Openship Cloud offers. A preset larger than the machine is greyed out rather than silently unhonored.
• Custom — type your own vCPU and MB. 0 in either field means no limit for that dimension, so you can cap memory while leaving CPU free.

Limits apply when the container is recreated, so redeploy for a change to take effect. The card says so inline. Every deploy also logs the limits it applied (Resource limits: 2 vCPU · 4 GB, or no limits (machine capacity)), so a cap is never invisible.

A service in a compose project can override the project value for itself — see per-service limits.

Update an existing project's resources with a PATCH to its resources endpoint. All paths are under /api on your instance (for example https://your-host/api/...). Authenticate with a personal access token in the Authorization header — create one from Settings → Tokens or with openship token create. See Authentication for the full token model.

You can set production resources for your live app and build resources for compilation. Sizes are given as cpuCores, memoryMb, and diskMb. On Openship Cloud, build CPU/RAM are optional upper limits. Only configured values become Docker limits; omitted or zero dimensions remain uncapped. Send {"build": null} to remove the additional build limits. A saved build cap does not change production resources.

curl -X PATCH https://your-host/api/projects/PROJECT_ID/resources \
  -H "Authorization: Bearer $OPENSHIP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "production": { "cpuCores": 1, "memoryMb": 1024, "diskMb": 16384 },
    "build":      { "cpuCores": 2, "memoryMb": 2048, "diskMb": 16384 }
  }'

You can also send {"tier": "medium"} instead of explicit numbers, or {"tier": "unlimited"} to remove the caps on either server type.

0 means no limit. A non-zero cpuCores must be at least 0.25 and memoryMb at least 128; the UPPER bound is the target machine's own capacity, not a fixed number — so a large self-hosted box is usable in full. Managed server storage is controlled by its subscription, not the project's diskMb field. Resource fields are optional; omitted dimensions have no additional container cap.

GET /api/projects/PROJECT_ID/resources reads the current values, and also reports the detected machine capacity when available, plus requiresLimit: false for connected and managed hosts. Openship Cloud also returns buildMode: automatic or custom. In automatic mode, the returned build CPU/RAM values are zero and Docker receives no additional build limits. Cloud reservation accounting stays separate from those container settings.

# Let the app sleep when idle (the default, cheapest)
openship project sleep-mode PROJECT_ID auto_sleep

# Keep it running around the clock
openship project sleep-mode PROJECT_ID always_on

Don't know your project ID? openship project list shows every project with its ID.

curl -X POST https://your-host/api/projects/PROJECT_ID/sleep-mode \
  -H "Authorization: Bearer $OPENSHIP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "sleep_mode": "always_on" }'

sleep_mode must be auto_sleep or always_on. (You can also change it alongside resources by sending a sleepMode field to PATCH /api/projects/PROJECT_ID/resources.)