Deploy

Deploy an application on a VM

Creates a VM, runs a setup script (library script id or inline bash), and optionally fronts it with CDN and DNS. Pass ssh_key or ssh_key_ids to enable SSH access.

post/agent/deploy/app

Request

  • Base URL: https://edge.network
  • URL: https://edge.network/agent/deploy/app
  • Auth: HTTP bearer

Headers

X-Dry-Run'true' | 'false'

Set to "true" to preview the operation (validation, cost, plan) without making changes.

Idempotency-Keystring

Unique key for safe retries. Repeating a request with the same key returns the original response instead of re-executing.

Request body

projectstring required

Project name.

security_group_idsstring[]
domainstring

Response

VM provisioning started. Poll getVm until status is "running".

tell_userstring required

Human-readable summary of what happened, for the agent to relay to its operator.

Changes

No recorded changes to this operation across all 1 revision of this API.