ByCloud Docs
GuidesCLIAPISDK
post/v1/instances

Create instance

Create a new compute instance

Request Body

required

Content-Type: application/json

name

stringrequired

description

stringoptional

flavor_id

string<uuid>required

Flavor ID

image_id

string<uuid>optional

Image ID (required if not booting from volume)

key_name

stringoptional

SSH keypair name

security_groups

arrayoptional

Security group names or IDs

networks

arrayoptional

Networks to attach

volumes

arrayoptional

Volume attachments for boot from volume

metadata

objectoptional

tags

arrayoptional

user_data

string<byte>optional

Base64-encoded user data (cloud-init)

Responses

202

Instance creation initiated

Content-Type: application/json

instance

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
403

Insufficient permissions

Content-Type: application/json

error

objectrequired
409

Resource conflict (e.g., already exists, invalid state)

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X POST "https://api.spo1.mycloud.com/v1/instances" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-server-01",
    "description": "string",
    "flavor_id": "550e8400-e29b-41d4-a716-446655440000",
    "image_id": "550e8400-e29b-41d4-a716-446655440001",
    "key_name": "my-keypair",
    "security_groups": [
      "default",
      "web"
    ],
    "networks": [
      {
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "port": "550e8400-e29b-41d4-a716-446655440000",
        "fixed_ip": "string"
      }
    ],
    "volumes": [
      {
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "source_type": "volume",
        "destination_type": "volume",
        "boot_index": 0,
        "volume_size": 40,
        "volume_type": "string",
        "delete_on_termination": false,
        "device_name": "/dev/vda"
      }
    ],
    "metadata": {
      "environment": "production",
      "team": "backend"
    },
    "tags": [
      "web",
      "frontend"
    ],
    "user_data": "string"
  }'