FreestyleAPI ReferenceVm
Fork_vm
Fork VM
Path Parameters
vm_id*string
Request Body
application/json
idleTimeoutSeconds?integer|null
Format
int64ports?|null
Optional list of ports to expose externally. If not provided, port 3000 will be exposed on port 443 by default. Pass an empty array to disable external ports. Only ports 8081 and 443 can be configured externally for now. Any target port is allowed.
readySignalTimeoutSeconds?integer|null
Whether the api request should wait for the VM to be ready before returning. By default, the VM is considered ready when the serial console is ready for login.
Default
trueFormat
int64waitForReadySignal?boolean|null
How long to wait for the ready signal before timing out. Defaults to 120 seconds if not provided.
workdir?string|null
Optional working directory for the VM. File system and shell commands will be executed in this directory.
persistence?null|
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.freestyle.sh/v1/vms/string/fork" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "string",
"domains": [
"string"
],
"console_url": "string"
}{
"error": "string",
"message": "string"
}{
"error": "string",
"message": "string"
}{
"error": "string",
"message": "string"
}