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

Return to the regular view of this page.

List Launch Configurations

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

1 - 1.3

get /v1/launch-configurations

Description

List Launch Configurations.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
query	name optional	Launch Configuration name Example : `launch-configuration-name`	any of [string, null]
query	image_id optional	Image ID Example : `70a599e0-31e7-49b7-b260-868f441e862b`	any of [string, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	0
query	limit optional	Page size of items Example : `20`	any of [integer, null]	20
query	sort optional	Comma-separated list of sort keys and optional sort directions in the form of [:] Example : `created_at:asc`	any of [string, null]	created_at:asc

Responses

HTTP Code	Description	Schema
200	OK	LaunchConfigurationListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

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

{
    "count": 20,
    "launch_configurations": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "auto_scaling_group_count": 1,
            "boot_disk_size": 104,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "extra_disk_size": 104,
            "file_storage_ids": [
                ""
            ],
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "image_name": "imagename",
            "keypair_name": "keypairname",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "launch-configuration-name",
            "public_key": "ssh-rsa fakeKey Generated-by-SCP",
            "server_type_id": "s1v1m2",
            "state": "ACTIVE",
            "user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
            "volumes": [
                {
                    "boot_index": 0,
                    "size": 104,
                    "type": "SSD"
                }
            ]
        }
    ]
}

2 - 1.2

get /v1/launch-configurations

Description

List Launch Configurations.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
query	name optional	Launch Configuration name Example : `launch-configuration-name`	any of [string, null]
query	image_id optional	Image ID Example : `70a599e0-31e7-49b7-b260-868f441e862b`	any of [string, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	0
query	limit optional	Page size of items Example : `20`	any of [integer, null]	20
query	sort optional	Comma-separated list of sort keys and optional sort directions in the form of [:] Example : `created_at:asc`	any of [string, null]	created_at:asc

Responses

HTTP Code	Description	Schema
200	OK	LaunchConfigurationListResponseV1Dot2
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

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

{
    "count": 20,
    "launch_configurations": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "auto_scaling_group_count": 1,
            "boot_disk_size": 104,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "extra_disk_size": 104,
            "file_storage_ids": [
                ""
            ],
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "image_name": "imagename",
            "keypair_name": "keypairname",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "launch-configuration-name",
            "public_key": "ssh-rsa fakeKey Generated-by-SCP",
            "server_type_id": "s1v1m2",
            "state": "ACTIVE",
            "user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
            "volumes": [
                {
                    "boot_index": 0,
                    "size": 104,
                    "type": "SSD"
                }
            ]
        }
    ]
}

3 - 1.1

get /v1/launch-configurations

Description

List Launch Configurations.

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	name optional	Launch Configuration name Example : `launch-configuration-name`	any of [string, null]
query	image_id optional	Image ID Example : `70a599e0-31e7-49b7-b260-868f441e862b`	any of [string, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	0
query	limit optional	Page size of items Example : `20`	any of [integer, null]	20
query	sort optional	Comma-separated list of sort keys and optional sort directions in the form of [:] Example : `created_at:asc`	any of [string, null]	created_at:asc

Responses

HTTP Code	Description	Schema
200	OK	LaunchConfigurationListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

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

{
    "count": 20,
    "launch_configurations": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "auto_scaling_group_count": 1,
            "boot_disk_size": 104,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "extra_disk_size": 104,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "image_name": "imagename",
            "keypair_name": "keypairname",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "launch-configuration-name",
            "public_key": "ssh-rsa fakeKey Generated-by-SCP",
            "server_type_id": "s1v1m2",
            "state": "ACTIVE",
            "user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
            "volumes": [
                {
                    "boot_index": 0,
                    "size": 104,
                    "type": "SSD"
                }
            ]
        }
    ]
}

4 - 1.0

get /v1/launch-configurations

Description

List Launch Configurations.

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	name optional	Launch Configuration name Example : `launch-configuration-name`	any of [string, null]
query	image_id optional	Image ID Example : `70a599e0-31e7-49b7-b260-868f441e862b`	any of [string, null]	None
query	offset optional	Index of where to start in the list Example : `0`	any of [integer, null]	0
query	limit optional	Page size of items Example : `20`	any of [integer, null]	20
query	sort optional	Comma-separated list of sort keys and optional sort directions in the form of [:] Example : `created_at:asc`	any of [string, null]	created_at:asc

Responses

HTTP Code	Description	Schema
200	OK	LaunchConfigurationListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/launch-configurations

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

{
    "count": 20,
    "launch_configurations": [
        {
            "account_id": "a8f10467abfc4b87b64614ab36eb9ae4",
            "auto_scaling_group_count": 1,
            "boot_disk_size": 104,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "extra_disk_size": 104,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "image_id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "image_name": "imagename",
            "keypair_name": "keypairname",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "launch-configuration-name",
            "public_key": "ssh-rsa fakeKey Generated-by-SCP",
            "server_type_id": "s1v1m2",
            "state": "ACTIVE",
            "user_data": "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
            "volumes": [
                {
                    "boot_index": 0,
                    "size": 104,
                    "type": "SSD"
                }
            ]
        }
    ]
}