This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

List Server Groups

1: 1.3
2: 1.2
3: 1.1
4: 1.0

1 - 1.3

get /v1/server-groups

Description

Get server group list.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Page size of items Example : `20`	any of [integer, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ServerGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "server_groups": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
            "members": [
                "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
            ],
            "name": "server-group",
            "partition_size": 3,
            "policy": "anti-affinity",
            "user_id": "570907805e5447be84b618450ef52o0t"
        }
    ]
}

2 - 1.2

get /v1/server-groups

Description

Get server group list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Page size of items Example : `20`	any of [integer, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ServerGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"

Example HTTP response

Response 200

{
    "server_groups": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
            "members": [
                "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
            ],
            "name": "server-group",
            "partition_size": 3,
            "policy": "anti-affinity",
            "user_id": "570907805e5447be84b618450ef52o0t"
        }
    ]
}

3 - 1.1

get /v1/server-groups

Description

Get server group list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.1	20260531

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Page size of items Example : `20`	any of [integer, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ServerGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"

Example HTTP response

Response 200

{
    "server_groups": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
            "members": [
                "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
            ],
            "name": "server-group",
            "partition_size": 3,
            "policy": "anti-affinity",
            "user_id": "570907805e5447be84b618450ef52o0t"
        }
    ]
}

4 - 1.0

get /v1/server-groups

Description

Get server group list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Page size of items Example : `20`	any of [integer, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ServerGroupListResponse
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/server-groups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"

Example HTTP response

Response 200

{
    "server_groups": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
            "members": [
                "2a9be312-5d4b-4bc8-b2ae-35100fa9241f"
            ],
            "name": "server-group",
            "partition_size": 3,
            "policy": "anti-affinity",
            "user_id": "570907805e5447be84b618450ef52o0t"
        }
    ]
}