Skip to content
Doprax DocsDoprax DocsDoprax Docs

api_v2_services_instances_create

POST
/api/v2/services/instances/
curl --request POST \
  --url https://example.com/api/v2/services/instances/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "product_version_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "idempotency_key": "example", "name": "example", "description": "example", "metadata": { "additionalProperty": "example" }, "selections": { "additionalProperty": "example" }, "app_name": "example", "image": "example", "container_name": "example", "container_code": "example", "container_codes": [ "example" ], "container_id": "example", "container_ids": [ "example" ] }'

Create a new VM service instance from a plan (product_version_id) with either a standard OS install, SSH-key access, or restore-from-snapshot.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
object
product_version_id
required
string format: uuid
idempotency_key
required
string
>= 1 characters
name
string
description
string
metadata
object
key
additional properties
selections
object
key
additional properties
app_name
string
image
string
container_name
string
container_code
string
>= 1 characters
container_codes
Array<string>
container_id
string
>= 1 characters
container_ids
Array<string>

Example generated

{
  "product_version_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "idempotency_key": "example",
  "name": "example",
  "description": "example",
  "metadata": {
    "additionalProperty": "example"
  },
  "selections": {
    "additionalProperty": "example"
  },
  "app_name": "example",
  "image": "example",
  "container_name": "example",
  "container_code": "example",
  "container_codes": [
    "example"
  ],
  "container_id": "example",
  "container_ids": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
success
boolean
idempotent
boolean
operation_id
required
string format: uuid
service_id
required
string format: uuid
status
required
string
action
required
string
task_id
string
nullable
status_reason
string
nullable
created_at
string format: date-time
nullable
started_at
string format: date-time
nullable
completed_at
string format: date-time
nullable
updated_at
string format: date-time
nullable

Example generated

{
  "success": true,
  "idempotent": true,
  "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "service_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status": "example",
  "action": "example",
  "task_id": "example",
  "status_reason": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "started_at": "2026-04-15T12:00:00Z",
  "completed_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z"
}

400

Section titled “400”
Media typeapplication/json
object
success
boolean
error
string

Example 

{
  "success": false
}