List server groups

Retrieves a list of server groups.

get/1.3/server-group

Request

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

Query parameters

keystring required

Label key used to classify the resource

valuestring required

Value associated with the label key

A label filter to apply. Format: key:value. Multiple labels can be specified by repeating the parameter.

{
  "key": "env",
  "value": "production"
}

Response

A list of server groups.

Example response

{
  "server_groups": {
    "server_group": [
      {
        "anti_affinity": "yes",
        "anti_affinity_status": [
          {
            "uuid": "00fce2f9-f9f4-46ff-86af-9e60f131f5cb",
            "status": "met"
          }
        ],
        "labels": {
          "label": [
            {
              "key": "env",
              "value": "prod"
            }
          ]
        },
        "servers": {
          "server": [
            "00fce2f9-f9f4-46ff-86af-9e60f131f5cb"
          ]
        },
        "title": "edge-cluster-a",
        "uuid": "00fce2f9-f9f4-46ff-86af-9e60f131f5cb"
      }
    ]
  }
}

Changes

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