server

List Cloud Servers

Returns the most relevant information for Cloud Servers associated with the current account.

get/1.3/server

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/server
  • Auth: HTTP bearer

Query parameters

labelstring

Filter by label key or key-value pair using "key" or "key=value". Repeat the parameter to require all labels.

uuidstring uuid

Universally unique identifier

Example:0414e0d7-4436-4037-9dd8-6eaf47dce599

Filter by Cloud Server UUID. Repeat the parameter to match any of up to five UUIDs.

hostinteger

Encoded Private Cloud host ID

Example:7653311107

Filter by Private Cloud host ID. Repeat the parameter to match any of up to five hosts.

devicestring

Filter by attached device using "type=gpu" or "type!=gpu". Repeat the parameter for up to five filters.

state'started' | 'stopped' | 'maintenance' | 'error'

Filter by the current Cloud Server state.

tagstring

One or more tag names. Use commas to match any tag, or colons to require all tags.

Example:prod,web

Filter by tag name. Separate names with commas to match any tag or colons to require all tags.

searchstring

Search UUIDs, titles, hostnames, zones, zone descriptions, IP addresses, tags, and template names.

sort_by'title' | 'zone' | 'size' | 'cores' | 'memory' | 'popularity'

Field to sort by.

order_by'asc' | 'desc'

Sort direction. Only applied when sort_by is specified.

limitinteger

Maximum number of items to return. Default is 25.

Example:25

Maximum number of Cloud Servers to return.

offsetinteger

Number of items to skip before starting to return results. Default is 0.

Number of Cloud Servers to skip.

Response

Cloud Server list returned successfully.

Example response

{
  "servers": {
    "server": [
      {
        "core_number": "2",
        "created": 1705320000,
        "hostname": "web-1.example.com",
        "license": "0",
        "memory_amount": "2048",
        "plan": "2xCPU-2GB",
        "labels": {
          "label": [
            {
              "key": "env",
              "value": "production"
            }
          ]
        },
        "plan_ipv4_bytes": "34253332",
        "plan_ipv6_bytes": "0",
        "simple_backup": "0100,dailies",
        "state": "started",
        "tags": {
          "tag": [
            "production",
            "web"
          ]
        },
        "title": "Production web server",
        "uuid": "007bf7bd-e3cf-4a10-bf01-4251dc7f3b65",
        "zone": "fi-hel1"
      }
    ]
  }
}

Changes

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