Server Group

Download schema

Server group management

List server groups

GET

https://api.upcloud.com

/1.3/server-group

Retrieves a list of server groups.

List server groups › query Parameters

serverGroupLabel

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

A key/value pair to label and categorize resources

List server groups › Responses

A list of server groups.

List of server groups

serverGroups

object · required

Create server group

POST

https://api.upcloud.com

/1.3/server-group

Creates a new server group.

Create server group › Request Body

A schema for creating/modifying a server group

serverGroupModify

object · required

Create server group › Responses

Details of the created server group.

A single server group

serverGroup

serverGroupDetails · required

Details of a server group

POST/1.3/server-group

curl https://api.upcloud.com/1.3/server-group \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "server_group": {
    "title": "title",
    "servers": {
      "servers": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "anti_affinity": "no"
  }
}'

Example Request Body

{
  "server_group": {
    "title": "title",
    "servers": {
      "servers": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "anti_affinity": "no"
  }
}

json

Example Responses

{
  "server_group": {
    "anti_affinity": "no",
    "anti_affinity_status": [
      {
        "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
        "status": "met"
      }
    ],
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "servers": {
      "server": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "title": "title",
    "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
  }
}

json

application/json

Get server group details

GET

https://api.upcloud.com

/1.3/server-group/{uuid}

Retrieves details of a specific server group.

Get server group details › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group to retrieve.

Universally unique identifier

Get server group details › Responses

Details of the server group.

A single server group

serverGroup

serverGroupDetails · required

Details of a server group

Delete server group

DELETE

https://api.upcloud.com

/1.3/server-group/{uuid}

Deletes a specific server group.

Delete server group › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group to delete.

Universally unique identifier

Delete server group › Responses

The server group was successfully deleted. No content is returned.

No data returned

Modify server group

PATCH

https://api.upcloud.com

/1.3/server-group/{uuid}

Modifies an existing server group.

Modify server group › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group to modify.

Universally unique identifier

Modify server group › Request Body

A schema for creating/modifying a server group

serverGroupModify

object · required

Modify server group › Responses

Details of the modified server group.

A single server group

serverGroup

serverGroupDetails · required

Details of a server group

PATCH/1.3/server-group/{uuid}

curl https://api.upcloud.com/1.3/server-group/:uuid \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "server_group": {
    "title": "title",
    "servers": {
      "servers": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "anti_affinity": "no"
  }
}'

Example Request Body

{
  "server_group": {
    "title": "title",
    "servers": {
      "servers": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "anti_affinity": "no"
  }
}

json

Example Responses

{
  "server_group": {
    "anti_affinity": "no",
    "anti_affinity_status": [
      {
        "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
        "status": "met"
      }
    ],
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "servers": {
      "server": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "title": "title",
    "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
  }
}

json

application/json

List server group members

GET

https://api.upcloud.com

/1.3/server-group/{uuid}/servers

Retrieves a list of servers that are members of a specific server group.

List server group members › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group whose members are to be listed.

Universally unique identifier

List server group members › Responses

A list of servers in the server group.

List of server UUIDs in the server group

serverGroupServers

servers

serverGroupUuid[] · required

Add server to group

POST

https://api.upcloud.com

/1.3/server-group/{uuid}/servers

Adds a server to a specific server group.

Add server to group › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group to which the server will be added.

Universally unique identifier

Add server to group › Request Body

Schema for adding a server to a server group

serverGroupServerAdd

object · required

Add server to group › Responses

The server was successfully added to the group. No content is returned.

No data returned

Remove server from group

DELETE

https://api.upcloud.com

/1.3/server-group/{uuid}/servers/{server_uuid}

Removes a server from a specific server group.

Remove server from group › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group from which the server will be removed.

Universally unique identifier

server_uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server to remove from the group.

Universally unique identifier

Remove server from group › Responses

The server was successfully removed from the group. No content is returned.

No data returned

Server Server Size

UpCloud API

Server Group

Download schema

Server group management

List server groups

GET

https://api.upcloud.com

/1.3/server-group

Retrieves a list of server groups.

List server groups › query Parameters

serverGroupLabel

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

A key/value pair to label and categorize resources

List server groups › Responses

A list of server groups.

List of server groups

serverGroups

object · required

Create server group

POST

https://api.upcloud.com

/1.3/server-group

Creates a new server group.

Create server group › Request Body

A schema for creating/modifying a server group

serverGroupModify

object · required

Create server group › Responses

Details of the created server group.

A single server group

serverGroup

serverGroupDetails · required

Details of a server group

POST/1.3/server-group

curl https://api.upcloud.com/1.3/server-group \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "server_group": {
    "title": "title",
    "servers": {
      "servers": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "anti_affinity": "no"
  }
}'

Example Request Body

{
  "server_group": {
    "title": "title",
    "servers": {
      "servers": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "anti_affinity": "no"
  }
}

json

Example Responses

{
  "server_group": {
    "anti_affinity": "no",
    "anti_affinity_status": [
      {
        "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
        "status": "met"
      }
    ],
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "servers": {
      "server": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "title": "title",
    "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
  }
}

json

application/json

Get server group details

GET

https://api.upcloud.com

/1.3/server-group/{uuid}

Retrieves details of a specific server group.

Get server group details › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group to retrieve.

Universally unique identifier

Get server group details › Responses

Details of the server group.

A single server group

serverGroup

serverGroupDetails · required

Details of a server group

Delete server group

DELETE

https://api.upcloud.com

/1.3/server-group/{uuid}

Deletes a specific server group.

Delete server group › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group to delete.

Universally unique identifier

Delete server group › Responses

The server group was successfully deleted. No content is returned.

No data returned

Modify server group

PATCH

https://api.upcloud.com

/1.3/server-group/{uuid}

Modifies an existing server group.

Modify server group › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group to modify.

Universally unique identifier

Modify server group › Request Body

A schema for creating/modifying a server group

serverGroupModify

object · required

Modify server group › Responses

Details of the modified server group.

A single server group

serverGroup

serverGroupDetails · required

Details of a server group

PATCH/1.3/server-group/{uuid}

curl https://api.upcloud.com/1.3/server-group/:uuid \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "server_group": {
    "title": "title",
    "servers": {
      "servers": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "anti_affinity": "no"
  }
}'

Example Request Body

{
  "server_group": {
    "title": "title",
    "servers": {
      "servers": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "anti_affinity": "no"
  }
}

json

Example Responses

{
  "server_group": {
    "anti_affinity": "no",
    "anti_affinity_status": [
      {
        "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599",
        "status": "met"
      }
    ],
    "labels": {
      "label": [
        {
          "key": "env",
          "value": "production"
        }
      ]
    },
    "servers": {
      "server": [
        "0414e0d7-4436-4037-9dd8-6eaf47dce599"
      ]
    },
    "title": "title",
    "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
  }
}

json

application/json

List server group members

GET

https://api.upcloud.com

/1.3/server-group/{uuid}/servers

Retrieves a list of servers that are members of a specific server group.

List server group members › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group whose members are to be listed.

Universally unique identifier

List server group members › Responses

A list of servers in the server group.

List of server UUIDs in the server group

serverGroupServers

servers

serverGroupUuid[] · required

Add server to group

POST

https://api.upcloud.com

/1.3/server-group/{uuid}/servers

Adds a server to a specific server group.

Add server to group › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group to which the server will be added.

Universally unique identifier

Add server to group › Request Body

Schema for adding a server to a server group

serverGroupServerAdd

object · required

Add server to group › Responses

The server was successfully added to the group. No content is returned.

No data returned

Remove server from group

DELETE

https://api.upcloud.com

/1.3/server-group/{uuid}/servers/{server_uuid}

Removes a server from a specific server group.

Remove server from group › path Parameters

uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server group from which the server will be removed.

Universally unique identifier

server_uuid

serverGroupUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The UUID of the server to remove from the group.

Universally unique identifier

Remove server from group › Responses

The server was successfully removed from the group. No content is returned.

No data returned

Server Server Size