Server

Download schema

Manages virtual servers (also known as virtual machines or instances

Modify an existing server

PUT

https://api.upcloud.com

/1.3/server

Modifies an existing server

Modify an existing server › Request Body

Server object returned in responses

server

serverDetails · required

Detailed information about a server

Modify an existing server › Responses

Modified a server

Server object returned in responses

server

serverDetails · required

Detailed information about a server

PUT/1.3/server

curl https://api.upcloud.com/1.3/server \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "server": {
    "boot_order": "cdrom,disk",
    "core_number": 2,
    "created": 1705320000,
    "hostname": "example1",
    "license": 0,
    "memory_amount": 2048,
    "os_type": "ubuntu",
    "plan": "2xCPU-2GB",
    "plan_ipv4_bytes": 0,
    "plan_ipv6_bytes": 0,
    "state": "started",
    "tags": {
      "tag": []
    },
    "timezone": "UTC",
    "title": "First example server",
    "uuid": "007bf7bd-e3cf-4a10-bf01-4251dc7f3b65",
    "zone": "fi-hel1"
  }
}'

Example Request Body

{
  "server": {
    "boot_order": "cdrom,disk",
    "core_number": 2,
    "created": 1705320000,
    "hostname": "example1",
    "license": 0,
    "memory_amount": 2048,
    "os_type": "ubuntu",
    "plan": "2xCPU-2GB",
    "plan_ipv4_bytes": 0,
    "plan_ipv6_bytes": 0,
    "state": "started",
    "tags": {
      "tag": []
    },
    "timezone": "UTC",
    "title": "First example server",
    "uuid": "007bf7bd-e3cf-4a10-bf01-4251dc7f3b65",
    "zone": "fi-hel1"
  }
}

json

Example Responses

{
  "server": {
    "boot_order": "cdrom,disk",
    "core_number": 2,
    "created": 1705320000,
    "hostname": "example1",
    "license": 0,
    "memory_amount": 2048,
    "os_type": "ubuntu",
    "plan": "2xCPU-2GB",
    "plan_ipv4_bytes": 0,
    "plan_ipv6_bytes": 0,
    "state": "started",
    "tags": {
      "tag": []
    },
    "timezone": "UTC",
    "title": "First example server",
    "uuid": "007bf7bd-e3cf-4a10-bf01-4251dc7f3b65",
    "zone": "fi-hel1"
  }
}

json

application/json

Create a new server

POST

https://api.upcloud.com

/1.3/server

Creates a new server

Create a new server › Request Body

Server creation parameters

createServer

object · required

Create a new server › Responses

Created a server

Response schema for creating a server

createServerResponse

object · required

POST/1.3/server

curl https://api.upcloud.com/1.3/server \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "server": {
    "hostname": "my-server.example.com",
    "title": "My Server",
    "zone": "fi-hel1",
    "storage_devices": {
      "storage_device": [
        {
          "action": "clone",
          "storage": "01234567-89ab-cdef-0123-456789abcdef",
          "title": "Operating System"
        }
      ]
    }
  }
}'

Example Request Body

{
  "server": {
    "hostname": "my-server.example.com",
    "title": "My Server",
    "zone": "fi-hel1",
    "storage_devices": {
      "storage_device": [
        {
          "action": "clone",
          "storage": "01234567-89ab-cdef-0123-456789abcdef",
          "title": "Operating System"
        }
      ]
    }
  }
}

json

Example Responses

{
  "server": {
    "uuid": "00798b85-efdc-41ca-8021-f6ef457b8531",
    "title": "My Server",
    "hostname": "my-server.example.com",
    "zone": "fi-hel1",
    "storage_devices": {
      "storage_device": [
        {
          "storage": "01234567-89ab-cdef-0123-456789abcdef",
          "title": "Operating System"
        }
      ]
    },
    "state": "maintenance"
  }
}

json

application/json

Getting Started Server Group

Modify an existing server

PUT

https://api.upcloud.com

/1.3/server

Modifies an existing server

Modify an existing server › Request Body

Server object returned in responses

server

serverDetails · required

Detailed information about a server

Modify an existing server › Responses

Modified a server

Server object returned in responses

server

serverDetails · required

Detailed information about a server

Create a new server

POST

https://api.upcloud.com

/1.3/server

Creates a new server

Create a new server › Request Body

Server creation parameters

createServer

object · required

Create a new server › Responses

Created a server

Response schema for creating a server

createServerResponse

object · required